Harmonize image decoders' call_sequence states

This commit is contained in:
Nigel Tao committed 2020-12-19 22:42:49 +11:00
1 parent 9399c82409
commit 68fb70f9d5
4 files changed
+130 -71

No files matched your search

+37 -12
View File
@@ -33,6 +33,31 @@ pub struct decoder? implements base.image_decoder(
width : base.u32[..= 0x7FFF_FFFF],
height : base.u32[..= 0x7FFF_FFFF],
// Call sequence states:
// - 0x00: initial state.
// - 0x03: image config decoded.
// - 0x04: frame config decoded.
// - 0xFF: end-of-data, usually after (the non-animated) frame decoded.
//
// State transitions:
//
// - 0x00 -> 0x03: via DIC
// - 0x00 -> 0x04: via DFC with implicit DIC
// - 0x00 -> 0xFF: via DF with implicit DIC and DFC
//
// - 0x03 -> 0x04: via DFC
// - 0x03 -> 0xFF: via DF with implicit DFC
//
// - 0x04 -> 0xFF: via DFC
// - 0x04 -> 0xFF: via DF
//
// - ???? -> 0x03: via RF for ???? > 0x00
//
// Where:
// - DF is decode_frame
// - DFC is decode_frame_config, implicit means nullptr args.dst
// - DIC is decode_image_config, implicit means nullptr args.dst
// - RF is restart_frame
call_sequence : base.u8,
top_down : base.bool,
@@ -364,18 +389,18 @@ pub func decoder.decode_image_config?(dst: nptr base.image_config, src: base.io_
first_frame_is_opaque: this.channel_masks[3] == 0)
}
this.call_sequence = 1
this.call_sequence = 3
}
pub func decoder.decode_frame_config?(dst: nptr base.frame_config, src: base.io_reader) {
if this.call_sequence < 1 {
if this.call_sequence < 3 {
this.decode_image_config?(dst: nullptr, src: args.src)
} else if this.call_sequence == 1 {
} else if this.call_sequence == 3 {
if this.frame_config_io_position <> args.src.position() {
return base."#bad restart"
}
} else if this.call_sequence == 2 {
this.call_sequence = 3
} else if this.call_sequence == 4 {
this.call_sequence = 0xFF
return base."@end of data"
} else {
return base."@end of data"
@@ -396,15 +421,15 @@ pub func decoder.decode_frame_config?(dst: nptr base.frame_config, src: base.io_
background_color: 0xFF00_0000)
}
this.call_sequence = 2
this.call_sequence = 4
}
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) {
var status : base.status
if this.call_sequence < 2 {
if this.call_sequence < 4 {
this.decode_frame_config?(dst: nullptr, src: args.src)
} else if this.call_sequence == 2 {
} else if this.call_sequence == 4 {
// No-op.
} else {
return base."@end of data"
@@ -455,7 +480,7 @@ pub func decoder.decode_frame?(dst: ptr base.pixel_buffer, src: base.io_reader,
this.pending_pad = 0
}
this.call_sequence = 3
this.call_sequence = 0xFF
}
pri func decoder.swizzle_none!(dst: ptr base.pixel_buffer, src: base.io_reader) base.status {
@@ -1091,14 +1116,14 @@ pub func decoder.num_animation_loops() base.u32 {
}
pub func decoder.num_decoded_frame_configs() base.u64 {
if this.call_sequence > 1 {
if this.call_sequence > 3 {
return 1
}
return 0
}
pub func decoder.num_decoded_frames() base.u64 {
if this.call_sequence > 2 {
if this.call_sequence > 4 {
return 1
}
return 0
@@ -1111,7 +1136,7 @@ pub func decoder.restart_frame!(index: base.u64, io_position: base.u64) base.sta
if args.index <> 0 {
return base."#bad argument"
}
this.call_sequence = 1
this.call_sequence = 3
this.frame_config_io_position = args.io_position
return ok
}
+32 -23
View File
@@ -19,40 +19,49 @@ pub struct decoder? implements base.image_decoder(
height : base.u32,
// Call sequence states:
// - 0: initial state.
// - 1: metadata reported; image config decode is in progress.
// - 2: metadata finished; image config decode is in progress.
// - 3: image config decoded, including the first frame's bounds, but not
// the first frame's pixels.
// - 4: frame config decoded.
// - 5: frame decoded.
// - 0x00: initial state.
// - 0x01: metadata reported; image config decode is in progress.
// - 0x02: metadata finished; image config decode is in progress.
// - 0x03: image config decoded, including the first frame's bounds, but
// not the first frame's pixels.
// - 0x04: frame config decoded.
// - 0x05: frame decoded.
//
// GIF is unusual (distinguishing state 0x03 / state 0x05) in that the
// first frame's bounds can affect the overall image bounds (as per
// test/data/artificial/gif-frame-out-of-bounds.gif.make-artificial.txt).
// Decoding the first frame's bounds is part of DIC even though,
// conceptually, it should be part of the first DFC.
//
// State transitions:
//
// - 0 -> 1: via IC (metadata reported)
// - 0 -> 3: via IC (metadata not reported)
// - 0 -> 4: via FC with implicit IC
// - 0 -> 5: via F with implicit IC and FC
// - 0x00 -> 0x01: via DIC (metadata reported)
// - 0x00 -> 0x03: via DIC (metadata not reported)
// - 0x00 -> 0x04: via DFC with implicit DIC
// - 0x00 -> 0x05: via DF with implicit DIC and DFC
//
// - 1 -> 2: via AMC
// - 0x01 -> 0x02: via AMC
//
// - 2 -> 1: via IC (metadata reported)
// - 2 -> 3: via IC (metadata not reported)
// - 0x02 -> 0x01: via DIC (metadata reported)
// - 0x02 -> 0x03: via DIC (metadata not reported)
//
// - 3 -> 4: via FC
// - 3 -> 5: via F with implicit FC
// - 0x03 -> 0x04: via DFC
// - 0x03 -> 0x05: via DF with implicit DFC
//
// - 4 -> 4: via FC with implicit F
// - 4 -> 5: via F
// - 0x04 -> 0x04: via DFC with implicit DF
// - 0x04 -> 0x05: via DF
//
// - 5 -> 4: via FC
// - 5 -> 5: via F with implicit FC
// - 0x05 -> 0x04: via DFC
// - 0x05 -> 0x05: via DF with implicit DFC
//
// - ???? -> 0x05: via RF for ???? > 0x00
//
// Where:
// - AMC is ack_metadata_chunk
// - F is decode_frame, implicit means skip_frame
// - FC is decode_frame_config, implicit means nullptr args.dst
// - IC is decode_image_config, implicit means nullptr args.dst
// - DF is decode_frame, implicit means skip_frame
// - DFC is decode_frame_config, implicit means nullptr args.dst
// - DIC is decode_image_config, implicit means nullptr args.dst
// - RF is restart_frame
call_sequence : base.u8,
ignore_metadata : base.bool,
+37 -12
View File
@@ -20,6 +20,31 @@ pub struct decoder? implements base.image_decoder(
width : base.u32,
height : base.u32,
// Call sequence states:
// - 0x00: initial state.
// - 0x03: image config decoded.
// - 0x04: frame config decoded.
// - 0xFF: end-of-data, usually after (the non-animated) frame decoded.
//
// State transitions:
//
// - 0x00 -> 0x03: via DIC
// - 0x00 -> 0x04: via DFC with implicit DIC
// - 0x00 -> 0xFF: via DF with implicit DIC and DFC
//
// - 0x03 -> 0x04: via DFC
// - 0x03 -> 0xFF: via DF with implicit DFC
//
// - 0x04 -> 0xFF: via DFC
// - 0x04 -> 0xFF: via DF
//
// - ???? -> 0x03: via RF for ???? > 0x00
//
// Where:
// - DF is decode_frame
// - DFC is decode_frame_config, implicit means nullptr args.dst
// - DIC is decode_image_config, implicit means nullptr args.dst
// - RF is restart_frame
call_sequence : base.u8,
frame_config_io_position : base.u64,
@@ -91,18 +116,18 @@ pub func decoder.decode_image_config?(dst: nptr base.image_config, src: base.io_
first_frame_is_opaque: true)
}
this.call_sequence = 1
this.call_sequence = 3
}
pub func decoder.decode_frame_config?(dst: nptr base.frame_config, src: base.io_reader) {
if this.call_sequence < 1 {
if this.call_sequence < 3 {
this.decode_image_config?(dst: nullptr, src: args.src)
} else if this.call_sequence == 1 {
} else if this.call_sequence == 3 {
if this.frame_config_io_position <> args.src.position() {
return base."#bad restart"
}
} else if this.call_sequence == 2 {
this.call_sequence = 3
} else if this.call_sequence == 4 {
this.call_sequence = 0xFF
return base."@end of data"
} else {
return base."@end of data"
@@ -123,7 +148,7 @@ pub func decoder.decode_frame_config?(dst: nptr base.frame_config, src: base.io_
background_color: 0xFF00_0000)
}
this.call_sequence = 2
this.call_sequence = 4
}
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) {
@@ -139,9 +164,9 @@ pub func decoder.decode_frame?(dst: ptr base.pixel_buffer, src: base.io_reader,
var src : array[1] base.u8
var c : base.u8
if this.call_sequence < 2 {
if this.call_sequence < 4 {
this.decode_frame_config?(dst: nullptr, src: args.src)
} else if this.call_sequence == 2 {
} else if this.call_sequence == 4 {
// No-op.
} else {
return base."@end of data"
@@ -221,7 +246,7 @@ pub func decoder.decode_frame?(dst: ptr base.pixel_buffer, src: base.io_reader,
} endwhile
}
this.call_sequence = 3
this.call_sequence = 0xFF
}
pub func decoder.frame_dirty_rect() base.rect_ie_u32 {
@@ -237,14 +262,14 @@ pub func decoder.num_animation_loops() base.u32 {
}
pub func decoder.num_decoded_frame_configs() base.u64 {
if this.call_sequence > 1 {
if this.call_sequence > 3 {
return 1
}
return 0
}
pub func decoder.num_decoded_frames() base.u64 {
if this.call_sequence > 2 {
if this.call_sequence > 4 {
return 1
}
return 0
@@ -257,7 +282,7 @@ pub func decoder.restart_frame!(index: base.u64, io_position: base.u64) base.sta
if args.index <> 0 {
return base."#bad argument"
}
this.call_sequence = 1
this.call_sequence = 3
this.frame_config_io_position = args.io_position
return ok
}