diff --git a/doc/changelog.md b/doc/changelog.md index bbcaf68d..da723a1d 100644 --- a/doc/changelog.md +++ b/doc/changelog.md @@ -4,6 +4,7 @@ ## Work In Progress - Added `example/imageviewer`. +- Added `std/bmp`. - Added `std/gif.config_decoder`. - Added `std/wbmp`. - Added `WUFFS_BASE__PIXEL_BLEND__SRC_OVER`. diff --git a/release/c/wuffs-unsupported-snapshot.c b/release/c/wuffs-unsupported-snapshot.c index 72cd6380..cadbd745 100644 --- a/release/c/wuffs-unsupported-snapshot.c +++ b/release/c/wuffs-unsupported-snapshot.c @@ -3131,6 +3131,259 @@ extern "C" { // ---------------- Status Codes +extern const char* wuffs_bmp__error__bad_header; + +// ---------------- Public Consts + +#define WUFFS_BMP__DECODER_WORKBUF_LEN_MAX_INCL_WORST_CASE 0 + +// ---------------- Struct Declarations + +typedef struct wuffs_bmp__decoder__struct wuffs_bmp__decoder; + +// ---------------- Public Initializer Prototypes + +// For any given "wuffs_foo__bar* self", "wuffs_foo__bar__initialize(self, +// etc)" should be called before any other "wuffs_foo__bar__xxx(self, etc)". +// +// Pass sizeof(*self) and WUFFS_VERSION for sizeof_star_self and wuffs_version. +// Pass 0 (or some combination of WUFFS_INITIALIZE__XXX) for initialize_flags. + +wuffs_base__status WUFFS_BASE__WARN_UNUSED_RESULT // +wuffs_bmp__decoder__initialize(wuffs_bmp__decoder* self, + size_t sizeof_star_self, + uint64_t wuffs_version, + uint32_t initialize_flags); + +size_t // +sizeof__wuffs_bmp__decoder(); + +// ---------------- Upcasts + +static inline wuffs_base__image_decoder* // +wuffs_bmp__decoder__upcast_as__wuffs_base__image_decoder( + wuffs_bmp__decoder* p) { + return (wuffs_base__image_decoder*)p; +} + +// ---------------- Public Function Prototypes + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__decode_image_config(wuffs_bmp__decoder* self, + wuffs_base__image_config* a_dst, + wuffs_base__io_buffer* a_src); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__decode_frame_config(wuffs_bmp__decoder* self, + wuffs_base__frame_config* a_dst, + wuffs_base__io_buffer* a_src); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__decode_frame(wuffs_bmp__decoder* self, + wuffs_base__pixel_buffer* a_dst, + wuffs_base__io_buffer* a_src, + wuffs_base__pixel_blend a_blend, + wuffs_base__slice_u8 a_workbuf, + wuffs_base__decode_frame_options* a_opts); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__ack_metadata_chunk(wuffs_bmp__decoder* self, + wuffs_base__io_buffer* a_src); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__rect_ie_u32 // +wuffs_bmp__decoder__frame_dirty_rect(const wuffs_bmp__decoder* self); + +WUFFS_BASE__MAYBE_STATIC uint64_t // +wuffs_bmp__decoder__metadata_chunk_length(const wuffs_bmp__decoder* self); + +WUFFS_BASE__MAYBE_STATIC uint32_t // +wuffs_bmp__decoder__metadata_fourcc(const wuffs_bmp__decoder* self); + +WUFFS_BASE__MAYBE_STATIC uint32_t // +wuffs_bmp__decoder__num_animation_loops(const wuffs_bmp__decoder* self); + +WUFFS_BASE__MAYBE_STATIC uint64_t // +wuffs_bmp__decoder__num_decoded_frame_configs(const wuffs_bmp__decoder* self); + +WUFFS_BASE__MAYBE_STATIC uint64_t // +wuffs_bmp__decoder__num_decoded_frames(const wuffs_bmp__decoder* self); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__restart_frame(wuffs_bmp__decoder* self, + uint64_t a_index, + uint64_t a_io_position); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__empty_struct // +wuffs_bmp__decoder__set_report_metadata(wuffs_bmp__decoder* self, + uint32_t a_fourcc, + bool a_report); + +WUFFS_BASE__MAYBE_STATIC wuffs_base__range_ii_u64 // +wuffs_bmp__decoder__workbuf_len(const wuffs_bmp__decoder* self); + +// ---------------- Struct Definitions + +// These structs' fields, and the sizeof them, are private implementation +// details that aren't guaranteed to be stable across Wuffs versions. +// +// See https://en.wikipedia.org/wiki/Opaque_pointer#C + +#if defined(__cplusplus) || defined(WUFFS_IMPLEMENTATION) + +struct wuffs_bmp__decoder__struct { + // Do not access the private_impl's or private_data's fields directly. There + // is no API/ABI compatibility or safety guarantee if you do so. Instead, use + // the wuffs_foo__bar__baz functions. + // + // It is a struct, not a struct*, so that the outermost wuffs_foo__bar struct + // can be stack allocated when WUFFS_IMPLEMENTATION is defined. + + struct { + uint32_t magic; + uint32_t active_coroutine; + wuffs_base__vtable vtable_for__wuffs_base__image_decoder; + wuffs_base__vtable null_vtable; + + uint32_t f_width; + uint32_t f_height; + uint8_t f_call_sequence; + uint64_t f_frame_config_io_position; + wuffs_base__pixel_swizzler f_swizzler; + + uint32_t p_decode_frame_config[1]; + uint32_t p_decode_frame[1]; + } private_impl; + +#ifdef __cplusplus +#if (__cplusplus >= 201103L) && !defined(WUFFS_IMPLEMENTATION) + // Disallow constructing or copying an object via standard C++ mechanisms, + // e.g. the "new" operator, as this struct is intentionally opaque. Its total + // size and field layout is not part of the public, stable, memory-safe API. + // Use malloc or memcpy and the sizeof__wuffs_foo__bar function instead, and + // call wuffs_foo__bar__baz methods (which all take a "this"-like pointer as + // their first argument) rather than tweaking bar.private_impl.qux fields. + // + // In C, we can just leave wuffs_foo__bar as an incomplete type (unless + // WUFFS_IMPLEMENTATION is #define'd). In C++, we define a complete type in + // order to provide convenience methods. These forward on "this", so that you + // can write "bar->baz(etc)" instead of "wuffs_foo__bar__baz(bar, etc)". + wuffs_bmp__decoder__struct() = delete; + wuffs_bmp__decoder__struct(const wuffs_bmp__decoder__struct&) = delete; + wuffs_bmp__decoder__struct& operator=(const wuffs_bmp__decoder__struct&) = + delete; + + // As above, the size of the struct is not part of the public API, and unless + // WUFFS_IMPLEMENTATION is #define'd, this struct type T should be heap + // allocated, not stack allocated. Its size is not intended to be known at + // compile time, but it is unfortunately divulged as a side effect of + // defining C++ convenience methods. Use "sizeof__T()", calling the function, + // instead of "sizeof T", invoking the operator. To make the two values + // different, so that passing the latter will be rejected by the initialize + // function, we add an arbitrary amount of dead weight. + uint8_t dead_weight[123000000]; // 123 MB. +#endif // (__cplusplus >= 201103L) && !defined(WUFFS_IMPLEMENTATION) + + inline wuffs_base__status WUFFS_BASE__WARN_UNUSED_RESULT // + initialize(size_t sizeof_star_self, + uint64_t wuffs_version, + uint32_t initialize_flags) { + return wuffs_bmp__decoder__initialize(this, sizeof_star_self, wuffs_version, + initialize_flags); + } + + inline wuffs_base__image_decoder* // + upcast_as__wuffs_base__image_decoder() { + return (wuffs_base__image_decoder*)this; + } + + inline wuffs_base__status // + decode_image_config(wuffs_base__image_config* a_dst, + wuffs_base__io_buffer* a_src) { + return wuffs_bmp__decoder__decode_image_config(this, a_dst, a_src); + } + + inline wuffs_base__status // + decode_frame_config(wuffs_base__frame_config* a_dst, + wuffs_base__io_buffer* a_src) { + return wuffs_bmp__decoder__decode_frame_config(this, a_dst, a_src); + } + + inline wuffs_base__status // + decode_frame(wuffs_base__pixel_buffer* a_dst, + wuffs_base__io_buffer* a_src, + wuffs_base__pixel_blend a_blend, + wuffs_base__slice_u8 a_workbuf, + wuffs_base__decode_frame_options* a_opts) { + return wuffs_bmp__decoder__decode_frame(this, a_dst, a_src, a_blend, + a_workbuf, a_opts); + } + + inline wuffs_base__status // + ack_metadata_chunk(wuffs_base__io_buffer* a_src) { + return wuffs_bmp__decoder__ack_metadata_chunk(this, a_src); + } + + inline wuffs_base__rect_ie_u32 // + frame_dirty_rect() const { + return wuffs_bmp__decoder__frame_dirty_rect(this); + } + + inline uint64_t // + metadata_chunk_length() const { + return wuffs_bmp__decoder__metadata_chunk_length(this); + } + + inline uint32_t // + metadata_fourcc() const { + return wuffs_bmp__decoder__metadata_fourcc(this); + } + + inline uint32_t // + num_animation_loops() const { + return wuffs_bmp__decoder__num_animation_loops(this); + } + + inline uint64_t // + num_decoded_frame_configs() const { + return wuffs_bmp__decoder__num_decoded_frame_configs(this); + } + + inline uint64_t // + num_decoded_frames() const { + return wuffs_bmp__decoder__num_decoded_frames(this); + } + + inline wuffs_base__status // + restart_frame(uint64_t a_index, uint64_t a_io_position) { + return wuffs_bmp__decoder__restart_frame(this, a_index, a_io_position); + } + + inline wuffs_base__empty_struct // + set_report_metadata(uint32_t a_fourcc, bool a_report) { + return wuffs_bmp__decoder__set_report_metadata(this, a_fourcc, a_report); + } + + inline wuffs_base__range_ii_u64 // + workbuf_len() const { + return wuffs_bmp__decoder__workbuf_len(this); + } + +#endif // __cplusplus + +}; // struct wuffs_bmp__decoder__struct + +#endif // defined(__cplusplus) || defined(WUFFS_IMPLEMENTATION) + +#ifdef __cplusplus +} // extern "C" +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +// ---------------- Status Codes + // ---------------- Public Consts // ---------------- Struct Declarations @@ -7091,6 +7344,586 @@ wuffs_adler32__hasher__update_u32(wuffs_adler32__hasher* self, #endif // !defined(WUFFS_CONFIG__MODULES) || // defined(WUFFS_CONFIG__MODULE__ADLER32) +#if !defined(WUFFS_CONFIG__MODULES) || defined(WUFFS_CONFIG__MODULE__BMP) + +// ---------------- Status Codes Implementations + +const char* wuffs_bmp__error__bad_header = "#bmp: bad header"; + +// ---------------- Private Consts + +// ---------------- Private Initializer Prototypes + +// ---------------- Private Function Prototypes + +static wuffs_base__status // +wuffs_bmp__decoder__skip_frame(wuffs_bmp__decoder* self, + wuffs_base__io_buffer* a_src); + +// ---------------- VTables + +const wuffs_base__image_decoder__func_ptrs + wuffs_bmp__decoder__func_ptrs_for__wuffs_base__image_decoder = { + (wuffs_base__status(*)(void*, wuffs_base__io_buffer*))( + &wuffs_bmp__decoder__ack_metadata_chunk), + (wuffs_base__status(*)(void*, + wuffs_base__pixel_buffer*, + wuffs_base__io_buffer*, + wuffs_base__pixel_blend, + wuffs_base__slice_u8, + wuffs_base__decode_frame_options*))( + &wuffs_bmp__decoder__decode_frame), + (wuffs_base__status(*)(void*, + wuffs_base__frame_config*, + wuffs_base__io_buffer*))( + &wuffs_bmp__decoder__decode_frame_config), + (wuffs_base__status(*)(void*, + wuffs_base__image_config*, + wuffs_base__io_buffer*))( + &wuffs_bmp__decoder__decode_image_config), + (wuffs_base__rect_ie_u32(*)(const void*))( + &wuffs_bmp__decoder__frame_dirty_rect), + (uint64_t(*)(const void*))(&wuffs_bmp__decoder__metadata_chunk_length), + (uint32_t(*)(const void*))(&wuffs_bmp__decoder__metadata_fourcc), + (uint32_t(*)(const void*))(&wuffs_bmp__decoder__num_animation_loops), + (uint64_t(*)(const void*))( + &wuffs_bmp__decoder__num_decoded_frame_configs), + (uint64_t(*)(const void*))(&wuffs_bmp__decoder__num_decoded_frames), + (wuffs_base__status(*)(void*, uint64_t, uint64_t))( + &wuffs_bmp__decoder__restart_frame), + (wuffs_base__empty_struct(*)(void*, uint32_t, bool))( + &wuffs_bmp__decoder__set_report_metadata), + (wuffs_base__range_ii_u64(*)(const void*))( + &wuffs_bmp__decoder__workbuf_len), +}; + +// ---------------- Initializer Implementations + +wuffs_base__status WUFFS_BASE__WARN_UNUSED_RESULT // +wuffs_bmp__decoder__initialize(wuffs_bmp__decoder* self, + size_t sizeof_star_self, + uint64_t wuffs_version, + uint32_t initialize_flags) { + if (!self) { + return wuffs_base__make_status(wuffs_base__error__bad_receiver); + } + if (sizeof(*self) != sizeof_star_self) { + return wuffs_base__make_status(wuffs_base__error__bad_sizeof_receiver); + } + if (((wuffs_version >> 32) != WUFFS_VERSION_MAJOR) || + (((wuffs_version >> 16) & 0xFFFF) > WUFFS_VERSION_MINOR)) { + return wuffs_base__make_status(wuffs_base__error__bad_wuffs_version); + } + + if ((initialize_flags & WUFFS_INITIALIZE__ALREADY_ZEROED) != 0) { +// The whole point of this if-check is to detect an uninitialized *self. +// We disable the warning on GCC. Clang-5.0 does not have this warning. +#if !defined(__clang__) && defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wmaybe-uninitialized" +#endif + if (self->private_impl.magic != 0) { + return wuffs_base__make_status( + wuffs_base__error__initialize_falsely_claimed_already_zeroed); + } +#if !defined(__clang__) && defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + } else { + if ((initialize_flags & + WUFFS_INITIALIZE__LEAVE_INTERNAL_BUFFERS_UNINITIALIZED) == 0) { + memset(self, 0, sizeof(*self)); + initialize_flags |= WUFFS_INITIALIZE__ALREADY_ZEROED; + } else { + memset(&(self->private_impl), 0, sizeof(self->private_impl)); + } + } + + self->private_impl.magic = WUFFS_BASE__MAGIC; + self->private_impl.vtable_for__wuffs_base__image_decoder.vtable_name = + wuffs_base__image_decoder__vtable_name; + self->private_impl.vtable_for__wuffs_base__image_decoder.function_pointers = + (const void*)(&wuffs_bmp__decoder__func_ptrs_for__wuffs_base__image_decoder); + return wuffs_base__make_status(NULL); +} + +size_t // +sizeof__wuffs_bmp__decoder() { + return sizeof(wuffs_bmp__decoder); +} + +// ---------------- Function Implementations + +// -------- func bmp.decoder.decode_image_config + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__decode_image_config(wuffs_bmp__decoder* self, + wuffs_base__image_config* a_dst, + wuffs_base__io_buffer* a_src) { + if (!self) { + return wuffs_base__make_status(wuffs_base__error__bad_receiver); + } + if (self->private_impl.magic != WUFFS_BASE__MAGIC) { + return wuffs_base__make_status( + (self->private_impl.magic == WUFFS_BASE__DISABLED) + ? wuffs_base__error__disabled_by_previous_error + : wuffs_base__error__initialize_not_called); + } + if (!a_src) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status(wuffs_base__error__bad_argument); + } + if ((self->private_impl.active_coroutine != 0) && + (self->private_impl.active_coroutine != 1)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status( + wuffs_base__error__interleaved_coroutine_calls); + } + self->private_impl.active_coroutine = 0; + wuffs_base__status status = wuffs_base__make_status(NULL); + + uint8_t* iop_a_src = NULL; + uint8_t* io0_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL; + uint8_t* io1_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL; + uint8_t* io2_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL; + if (a_src) { + io0_a_src = a_src->data.ptr; + io1_a_src = io0_a_src + a_src->meta.ri; + iop_a_src = io1_a_src; + io2_a_src = io0_a_src + a_src->meta.wi; + } + + if (self->private_impl.f_call_sequence != 0) { + status = wuffs_base__make_status(wuffs_base__error__bad_call_sequence); + goto exit; + } + self->private_impl.f_width = 1; + self->private_impl.f_height = 1; + self->private_impl.f_frame_config_io_position = wuffs_base__u64__sat_add( + a_src->meta.pos, ((uint64_t)(iop_a_src - io0_a_src))); + if (a_dst != NULL) { + wuffs_base__image_config__set( + a_dst, 1157662856, 0, self->private_impl.f_width, + self->private_impl.f_height, + self->private_impl.f_frame_config_io_position, true); + } + self->private_impl.f_call_sequence = 1; + + goto ok; +ok: + goto exit; +exit: + if (a_src) { + a_src->meta.ri = ((size_t)(iop_a_src - a_src->data.ptr)); + } + + if (wuffs_base__status__is_error(&status)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + } + return status; +} + +// -------- func bmp.decoder.decode_frame_config + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__decode_frame_config(wuffs_bmp__decoder* self, + wuffs_base__frame_config* a_dst, + wuffs_base__io_buffer* a_src) { + if (!self) { + return wuffs_base__make_status(wuffs_base__error__bad_receiver); + } + if (self->private_impl.magic != WUFFS_BASE__MAGIC) { + return wuffs_base__make_status( + (self->private_impl.magic == WUFFS_BASE__DISABLED) + ? wuffs_base__error__disabled_by_previous_error + : wuffs_base__error__initialize_not_called); + } + if (!a_src) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status(wuffs_base__error__bad_argument); + } + if ((self->private_impl.active_coroutine != 0) && + (self->private_impl.active_coroutine != 2)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status( + wuffs_base__error__interleaved_coroutine_calls); + } + self->private_impl.active_coroutine = 0; + wuffs_base__status status = wuffs_base__make_status(NULL); + + uint8_t* iop_a_src = NULL; + uint8_t* io0_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL; + uint8_t* io1_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL; + uint8_t* io2_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL; + if (a_src) { + io0_a_src = a_src->data.ptr; + io1_a_src = io0_a_src + a_src->meta.ri; + iop_a_src = io1_a_src; + io2_a_src = io0_a_src + a_src->meta.wi; + } + + uint32_t coro_susp_point = self->private_impl.p_decode_frame_config[0]; + if (coro_susp_point) { + } + switch (coro_susp_point) { + WUFFS_BASE__COROUTINE_SUSPENSION_POINT_0; + + if (self->private_impl.f_call_sequence < 1) { + if (a_src) { + a_src->meta.ri = ((size_t)(iop_a_src - a_src->data.ptr)); + } + WUFFS_BASE__COROUTINE_SUSPENSION_POINT(1); + status = wuffs_bmp__decoder__decode_image_config(self, NULL, a_src); + if (a_src) { + iop_a_src = a_src->data.ptr + a_src->meta.ri; + } + if (status.repr) { + goto suspend; + } + } else if (self->private_impl.f_call_sequence == 1) { + if (self->private_impl.f_frame_config_io_position != + wuffs_base__u64__sat_add(a_src->meta.pos, + ((uint64_t)(iop_a_src - io0_a_src)))) { + status = wuffs_base__make_status(wuffs_base__error__bad_restart); + goto exit; + } + } else if (self->private_impl.f_call_sequence == 2) { + if (a_src) { + a_src->meta.ri = ((size_t)(iop_a_src - a_src->data.ptr)); + } + WUFFS_BASE__COROUTINE_SUSPENSION_POINT(2); + status = wuffs_bmp__decoder__skip_frame(self, a_src); + if (a_src) { + iop_a_src = a_src->data.ptr + a_src->meta.ri; + } + if (status.repr) { + goto suspend; + } + status = wuffs_base__make_status(wuffs_base__note__end_of_data); + goto ok; + } else { + status = wuffs_base__make_status(wuffs_base__note__end_of_data); + goto ok; + } + if (a_dst != NULL) { + wuffs_base__frame_config__update( + a_dst, + wuffs_base__utility__make_rect_ie_u32( + 0, 0, self->private_impl.f_width, self->private_impl.f_height), + ((wuffs_base__flicks)(0)), 0, + self->private_impl.f_frame_config_io_position, 0, true, false, + 4278190080); + } + self->private_impl.f_call_sequence = 2; + + goto ok; + ok: + self->private_impl.p_decode_frame_config[0] = 0; + goto exit; + } + + goto suspend; +suspend: + self->private_impl.p_decode_frame_config[0] = + wuffs_base__status__is_suspension(&status) ? coro_susp_point : 0; + self->private_impl.active_coroutine = + wuffs_base__status__is_suspension(&status) ? 2 : 0; + + goto exit; +exit: + if (a_src) { + a_src->meta.ri = ((size_t)(iop_a_src - a_src->data.ptr)); + } + + if (wuffs_base__status__is_error(&status)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + } + return status; +} + +// -------- func bmp.decoder.decode_frame + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__decode_frame(wuffs_bmp__decoder* self, + wuffs_base__pixel_buffer* a_dst, + wuffs_base__io_buffer* a_src, + wuffs_base__pixel_blend a_blend, + wuffs_base__slice_u8 a_workbuf, + wuffs_base__decode_frame_options* a_opts) { + if (!self) { + return wuffs_base__make_status(wuffs_base__error__bad_receiver); + } + if (self->private_impl.magic != WUFFS_BASE__MAGIC) { + return wuffs_base__make_status( + (self->private_impl.magic == WUFFS_BASE__DISABLED) + ? wuffs_base__error__disabled_by_previous_error + : wuffs_base__error__initialize_not_called); + } + if (!a_dst || !a_src) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status(wuffs_base__error__bad_argument); + } + if ((self->private_impl.active_coroutine != 0) && + (self->private_impl.active_coroutine != 3)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status( + wuffs_base__error__interleaved_coroutine_calls); + } + self->private_impl.active_coroutine = 0; + wuffs_base__status status = wuffs_base__make_status(NULL); + + uint32_t coro_susp_point = self->private_impl.p_decode_frame[0]; + if (coro_susp_point) { + } + switch (coro_susp_point) { + WUFFS_BASE__COROUTINE_SUSPENSION_POINT_0; + + if (self->private_impl.f_call_sequence < 2) { + WUFFS_BASE__COROUTINE_SUSPENSION_POINT(1); + status = wuffs_bmp__decoder__decode_frame_config(self, NULL, a_src); + if (status.repr) { + goto suspend; + } + } else if (self->private_impl.f_call_sequence == 2) { + } else { + status = wuffs_base__make_status(wuffs_base__note__end_of_data); + goto ok; + } + self->private_impl.f_call_sequence = 3; + + goto ok; + ok: + self->private_impl.p_decode_frame[0] = 0; + goto exit; + } + + goto suspend; +suspend: + self->private_impl.p_decode_frame[0] = + wuffs_base__status__is_suspension(&status) ? coro_susp_point : 0; + self->private_impl.active_coroutine = + wuffs_base__status__is_suspension(&status) ? 3 : 0; + + goto exit; +exit: + if (wuffs_base__status__is_error(&status)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + } + return status; +} + +// -------- func bmp.decoder.skip_frame + +static wuffs_base__status // +wuffs_bmp__decoder__skip_frame(wuffs_bmp__decoder* self, + wuffs_base__io_buffer* a_src) { + wuffs_base__status status = wuffs_base__make_status(NULL); + + self->private_impl.f_call_sequence = 3; + + goto ok; +ok: + goto exit; +exit: + return status; +} + +// -------- func bmp.decoder.ack_metadata_chunk + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__ack_metadata_chunk(wuffs_bmp__decoder* self, + wuffs_base__io_buffer* a_src) { + if (!self) { + return wuffs_base__make_status(wuffs_base__error__bad_receiver); + } + if (self->private_impl.magic != WUFFS_BASE__MAGIC) { + return wuffs_base__make_status( + (self->private_impl.magic == WUFFS_BASE__DISABLED) + ? wuffs_base__error__disabled_by_previous_error + : wuffs_base__error__initialize_not_called); + } + if (!a_src) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status(wuffs_base__error__bad_argument); + } + if ((self->private_impl.active_coroutine != 0) && + (self->private_impl.active_coroutine != 4)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + return wuffs_base__make_status( + wuffs_base__error__interleaved_coroutine_calls); + } + self->private_impl.active_coroutine = 0; + wuffs_base__status status = wuffs_base__make_status(NULL); + + status = wuffs_base__make_status(NULL); + goto ok; + goto ok; +ok: + goto exit; +exit: + if (wuffs_base__status__is_error(&status)) { + self->private_impl.magic = WUFFS_BASE__DISABLED; + } + return status; +} + +// -------- func bmp.decoder.frame_dirty_rect + +WUFFS_BASE__MAYBE_STATIC wuffs_base__rect_ie_u32 // +wuffs_bmp__decoder__frame_dirty_rect(const wuffs_bmp__decoder* self) { + if (!self) { + return wuffs_base__utility__empty_rect_ie_u32(); + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return wuffs_base__utility__empty_rect_ie_u32(); + } + + return wuffs_base__utility__make_rect_ie_u32(0, 0, self->private_impl.f_width, + self->private_impl.f_height); +} + +// -------- func bmp.decoder.metadata_chunk_length + +WUFFS_BASE__MAYBE_STATIC uint64_t // +wuffs_bmp__decoder__metadata_chunk_length(const wuffs_bmp__decoder* self) { + if (!self) { + return 0; + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return 0; + } + + return 0; +} + +// -------- func bmp.decoder.metadata_fourcc + +WUFFS_BASE__MAYBE_STATIC uint32_t // +wuffs_bmp__decoder__metadata_fourcc(const wuffs_bmp__decoder* self) { + if (!self) { + return 0; + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return 0; + } + + return 0; +} + +// -------- func bmp.decoder.num_animation_loops + +WUFFS_BASE__MAYBE_STATIC uint32_t // +wuffs_bmp__decoder__num_animation_loops(const wuffs_bmp__decoder* self) { + if (!self) { + return 0; + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return 0; + } + + return 0; +} + +// -------- func bmp.decoder.num_decoded_frame_configs + +WUFFS_BASE__MAYBE_STATIC uint64_t // +wuffs_bmp__decoder__num_decoded_frame_configs(const wuffs_bmp__decoder* self) { + if (!self) { + return 0; + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return 0; + } + + if (self->private_impl.f_call_sequence > 1) { + return 1; + } + return 0; +} + +// -------- func bmp.decoder.num_decoded_frames + +WUFFS_BASE__MAYBE_STATIC uint64_t // +wuffs_bmp__decoder__num_decoded_frames(const wuffs_bmp__decoder* self) { + if (!self) { + return 0; + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return 0; + } + + if (self->private_impl.f_call_sequence > 2) { + return 1; + } + return 0; +} + +// -------- func bmp.decoder.restart_frame + +WUFFS_BASE__MAYBE_STATIC wuffs_base__status // +wuffs_bmp__decoder__restart_frame(wuffs_bmp__decoder* self, + uint64_t a_index, + uint64_t a_io_position) { + if (!self) { + return wuffs_base__make_status(wuffs_base__error__bad_receiver); + } + if (self->private_impl.magic != WUFFS_BASE__MAGIC) { + return wuffs_base__make_status( + (self->private_impl.magic == WUFFS_BASE__DISABLED) + ? wuffs_base__error__disabled_by_previous_error + : wuffs_base__error__initialize_not_called); + } + + if (self->private_impl.f_call_sequence == 0) { + return wuffs_base__make_status(wuffs_base__error__bad_call_sequence); + } + if (a_index != 0) { + return wuffs_base__make_status(wuffs_base__error__bad_argument); + } + self->private_impl.f_call_sequence = 1; + self->private_impl.f_frame_config_io_position = a_io_position; + return wuffs_base__make_status(NULL); +} + +// -------- func bmp.decoder.set_report_metadata + +WUFFS_BASE__MAYBE_STATIC wuffs_base__empty_struct // +wuffs_bmp__decoder__set_report_metadata(wuffs_bmp__decoder* self, + uint32_t a_fourcc, + bool a_report) { + if (!self) { + return wuffs_base__make_empty_struct(); + } + if (self->private_impl.magic != WUFFS_BASE__MAGIC) { + return wuffs_base__make_empty_struct(); + } + + return wuffs_base__make_empty_struct(); +} + +// -------- func bmp.decoder.workbuf_len + +WUFFS_BASE__MAYBE_STATIC wuffs_base__range_ii_u64 // +wuffs_bmp__decoder__workbuf_len(const wuffs_bmp__decoder* self) { + if (!self) { + return wuffs_base__utility__empty_range_ii_u64(); + } + if ((self->private_impl.magic != WUFFS_BASE__MAGIC) && + (self->private_impl.magic != WUFFS_BASE__DISABLED)) { + return wuffs_base__utility__empty_range_ii_u64(); + } + + return wuffs_base__utility__make_range_ii_u64(0, 0); +} + +#endif // !defined(WUFFS_CONFIG__MODULES) || defined(WUFFS_CONFIG__MODULE__BMP) + #if !defined(WUFFS_CONFIG__MODULES) || defined(WUFFS_CONFIG__MODULE__CRC32) // ---------------- Status Codes Implementations diff --git a/std/bmp/decode_bmp.wuffs b/std/bmp/decode_bmp.wuffs new file mode 100644 index 00000000..448915fd --- /dev/null +++ b/std/bmp/decode_bmp.wuffs @@ -0,0 +1,167 @@ +// Copyright 2020 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. + +pub status "#bad header" + +pub const decoder_workbuf_len_max_incl_worst_case base.u64 = 0 + +pub struct decoder? implements base.image_decoder( + width : base.u32, + height : base.u32, + + call_sequence : base.u8, + + frame_config_io_position : base.u64, + + swizzler : base.pixel_swizzler, + util : base.utility, +) + +pub func decoder.decode_image_config?(dst: nptr base.image_config, src: base.io_reader) { + if this.call_sequence <> 0 { + return base."#bad call sequence" + } + + // TODO. + this.width = 1 + this.height = 1 + + this.frame_config_io_position = args.src.position() + + if args.dst <> nullptr { + // TODO: a Wuffs (not just C) name for the + // WUFFS_BASE__PIXEL_FORMAT__BGRA_NONPREMUL magic pixfmt constant. + args.dst.set!( + pixfmt: 0x45008888, + pixsub: 0, + width: this.width, + height: this.height, + first_frame_io_position: this.frame_config_io_position, + first_frame_is_opaque: true) + } + + this.call_sequence = 1 +} + +pub func decoder.decode_frame_config?(dst: nptr base.frame_config, src: base.io_reader) { + if this.call_sequence < 1 { + this.decode_image_config?(dst: nullptr, src: args.src) + } else if this.call_sequence == 1 { + if this.frame_config_io_position <> args.src.position() { + return base."#bad restart" + } + } else if this.call_sequence == 2 { + this.skip_frame?(src: args.src) + return base."@end of data" + } else { + return base."@end of data" + } + + if args.dst <> nullptr { + args.dst.update!(bounds: this.util.make_rect_ie_u32( + min_incl_x: 0, + min_incl_y: 0, + max_excl_x: this.width, + max_excl_y: this.height), + duration: 0, + index: 0, + io_position: this.frame_config_io_position, + disposal: 0, + opaque_within_bounds: true, + overwrite_instead_of_blend: false, + background_color: 0xFF000000) + } + + this.call_sequence = 2 +} + +pub func decoder.decode_frame?(dst: ptr base.pixel_buffer, src: base.io_reader, blend: base.pixel_blend, workbuf: slice base.u8, opts: nptr base.decode_frame_options) { + if this.call_sequence < 2 { + this.decode_frame_config?(dst: nullptr, src: args.src) + } else if this.call_sequence == 2 { + // No-op. + } else { + return base."@end of data" + } + + // TODO. + + this.call_sequence = 3 +} + +pri func decoder.skip_frame?(src: base.io_reader) { + // TODO. + + this.call_sequence = 3 +} + +pub func decoder.ack_metadata_chunk?(src: base.io_reader) { + // TODO: this final line shouldn't be necessary, here and in some other + // std/*/*.wuffs functions. + return ok +} + +pub func decoder.frame_dirty_rect() base.rect_ie_u32 { + return this.util.make_rect_ie_u32( + min_incl_x: 0, + min_incl_y: 0, + max_excl_x: this.width, + max_excl_y: this.height) +} + +pub func decoder.metadata_chunk_length() base.u64 { + return 0 +} + +pub func decoder.metadata_fourcc() base.u32 { + return 0 +} + +pub func decoder.num_animation_loops() base.u32 { + return 0 +} + +pub func decoder.num_decoded_frame_configs() base.u64 { + if this.call_sequence > 1 { + return 1 + } + return 0 +} + +pub func decoder.num_decoded_frames() base.u64 { + if this.call_sequence > 2 { + return 1 + } + return 0 +} + +pub func decoder.restart_frame!(index: base.u64, io_position: base.u64) base.status { + if this.call_sequence == 0 { + return base."#bad call sequence" + } + if args.index <> 0 { + return base."#bad argument" + } + this.call_sequence = 1 + this.frame_config_io_position = args.io_position + return ok +} + +pub func decoder.set_report_metadata!(fourcc: base.u32, report: base.bool) { + // No-op. BMP doesn't support metadata. +} + +pub func decoder.workbuf_len() base.range_ii_u64 { + return this.util.make_range_ii_u64(min_incl: 0, max_incl: 0) +} diff --git a/test/c/std/bmp.c b/test/c/std/bmp.c new file mode 100644 index 00000000..1800703d --- /dev/null +++ b/test/c/std/bmp.c @@ -0,0 +1,137 @@ +// Copyright 2020 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. + +// ---------------- + +/* +This test program is typically run indirectly, by the "wuffs test" or "wuffs +bench" commands. These commands take an optional "-mimic" flag to check that +Wuffs' output mimics (i.e. exactly matches) other libraries' output, such as +giflib for GIF, libpng for PNG, etc. + +To manually run this test: + +for CC in clang gcc; do + $CC -std=c99 -Wall -Werror bmp.c && ./a.out + rm -f a.out +done + +Each edition should print "PASS", amongst other information, and exit(0). + +Add the "wuffs mimic cflags" (everything after the colon below) to the C +compiler flags (after the .c file) to run the mimic tests. + +To manually run the benchmarks, replace "-Wall -Werror" with "-O3" and replace +the first "./a.out" with "./a.out -bench". Combine these changes with the +"wuffs mimic cflags" to run the mimic benchmarks. +*/ + +// !! wuffs mimic cflags: -DWUFFS_MIMIC + +// Wuffs ships as a "single file C library" or "header file library" as per +// https://github.com/nothings/stb/blob/master/docs/stb_howto.txt +// +// To use that single file as a "foo.c"-like implementation, instead of a +// "foo.h"-like header, #define WUFFS_IMPLEMENTATION before #include'ing or +// compiling it. +#define WUFFS_IMPLEMENTATION + +// Defining the WUFFS_CONFIG__MODULE* macros are optional, but it lets users of +// release/c/etc.c whitelist which parts of Wuffs to build. That file contains +// the entire Wuffs standard library, implementing a variety of codecs and file +// formats. Without this macro definition, an optimizing compiler or linker may +// very well discard Wuffs code for unused codecs, but listing the Wuffs +// modules we use makes that process explicit. Preprocessing means that such +// code simply isn't compiled. +#define WUFFS_CONFIG__MODULES +#define WUFFS_CONFIG__MODULE__BASE +#define WUFFS_CONFIG__MODULE__BMP + +// If building this program in an environment that doesn't easily accommodate +// relative includes, you can use the script/inline-c-relative-includes.go +// program to generate a stand-alone C file. +#include "../../../release/c/wuffs-unsupported-snapshot.c" +#include "../testlib/testlib.c" +#ifdef WUFFS_MIMIC +// No mimic library. +#endif + +// ---------------- BMP Tests + +const char* test_wuffs_bmp_decode_interface() { + CHECK_FOCUS(__func__); + wuffs_bmp__decoder dec; + CHECK_STATUS("initialize", + wuffs_bmp__decoder__initialize( + &dec, sizeof dec, WUFFS_VERSION, + WUFFS_INITIALIZE__LEAVE_INTERNAL_BUFFERS_UNINITIALIZED)); + return do_test__wuffs_base__image_decoder( + wuffs_bmp__decoder__upcast_as__wuffs_base__image_decoder(&dec), + "test/data/hippopotamus.bmp", 0, SIZE_MAX, 1, 1, 0x00000000); +} + + // ---------------- Mimic Tests + +#ifdef WUFFS_MIMIC + + // No mimic tests. + +#endif // WUFFS_MIMIC + + // ---------------- BMP Benches + + // No BMP benches. + + // ---------------- Mimic Benches + +#ifdef WUFFS_MIMIC + + // No mimic benches. + +#endif // WUFFS_MIMIC + +// ---------------- Manifest + +// The empty comments forces clang-format to place one element per line. +proc tests[] = { + + test_wuffs_bmp_decode_interface, // + +#ifdef WUFFS_MIMIC + +// No mimic tests. + +#endif // WUFFS_MIMIC + + NULL, +}; + +// The empty comments forces clang-format to place one element per line. +proc benches[] = { + +// No BMP benches. + +#ifdef WUFFS_MIMIC + +// No mimic benches. + +#endif // WUFFS_MIMIC + + NULL, +}; + +int main(int argc, char** argv) { + proc_package_name = "std/bmp"; + return test_main(argc, argv, tests, benches); +}