summaryrefslogtreecommitdiff
path: root/python/examples/kaitai/gif.py
diff options
context:
space:
mode:
authorXusheng <xusheng@vector35.com>2021-07-01 12:34:30 +0800
committerXusheng Li <xushengli@protonmail.com>2021-07-05 10:11:47 +0800
commit13ff200ba134b8704f37eca99c42b70dab0d17dc (patch)
tree876b3db3c53f704b31152aeaede1f2edc9d27b24 /python/examples/kaitai/gif.py
parent4039a800349dcd587833d3e27d9137e4649818f4 (diff)
Remove snippet and kaitai plugin. Note their individual links.
Diffstat (limited to 'python/examples/kaitai/gif.py')
-rw-r--r--python/examples/kaitai/gif.py463
1 files changed, 0 insertions, 463 deletions
diff --git a/python/examples/kaitai/gif.py b/python/examples/kaitai/gif.py
deleted file mode 100644
index 82cfc7b6..00000000
--- a/python/examples/kaitai/gif.py
+++ /dev/null
@@ -1,463 +0,0 @@
-# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild
-
-from pkg_resources import parse_version
-from .kaitaistruct import __version__ as ks_version, KaitaiStruct, KaitaiStream, BytesIO
-from enum import Enum
-import collections
-
-
-if parse_version(ks_version) < parse_version('0.7'):
- raise Exception("Incompatible Kaitai Struct Python API: 0.7 or later is required, but you have %s" % (ks_version))
-
-class Gif(KaitaiStruct):
- """GIF (Graphics Interchange Format) is an image file format, developed
- in 1987. It became popular in 1990s as one of the main image formats
- used in World Wide Web.
-
- GIF format allows encoding of palette-based images up to 256 colors
- (each of the colors can be chosen from a 24-bit RGB
- colorspace). Image data stream uses LZW (LempelAAAZivAAAWelch) lossless
- compression.
-
- Over the years, several version of the format were published and
- several extensions to it were made, namely, a popular Netscape
- extension that allows to store several images in one file, switching
- between them, which produces crude form of animation.
-
- Structurally, format consists of several mandatory headers and then
- a stream of blocks follows. Blocks can carry additional
- metainformation or image data.
- """
-
- class BlockType(Enum):
- extension = 33
- local_image_descriptor = 44
- end_of_file = 59
-
- class ExtensionLabel(Enum):
- graphic_control = 249
- comment = 254
- application = 255
- SEQ_FIELDS = ["hdr", "logical_screen_descriptor", "global_color_table", "blocks"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['hdr']['start'] = self._io.pos()
- self.hdr = self._root.Header(self._io, self, self._root)
- self.hdr._read()
- self._debug['hdr']['end'] = self._io.pos()
- self._debug['logical_screen_descriptor']['start'] = self._io.pos()
- self.logical_screen_descriptor = self._root.LogicalScreenDescriptorStruct(self._io, self, self._root)
- self.logical_screen_descriptor._read()
- self._debug['logical_screen_descriptor']['end'] = self._io.pos()
- if self.logical_screen_descriptor.has_color_table:
- self._debug['global_color_table']['start'] = self._io.pos()
- self._raw_global_color_table = self._io.read_bytes((self.logical_screen_descriptor.color_table_size * 3))
- io = KaitaiStream(BytesIO(self._raw_global_color_table))
- self.global_color_table = self._root.ColorTable(io, self, self._root)
- self.global_color_table._read()
- self._debug['global_color_table']['end'] = self._io.pos()
-
- self._debug['blocks']['start'] = self._io.pos()
- self.blocks = []
- i = 0
- while True:
- if not 'arr' in self._debug['blocks']:
- self._debug['blocks']['arr'] = []
- self._debug['blocks']['arr'].append({'start': self._io.pos()})
- _t_blocks = self._root.Block(self._io, self, self._root)
- _t_blocks._read()
- _ = _t_blocks
- self.blocks.append(_)
- self._debug['blocks']['arr'][len(self.blocks) - 1]['end'] = self._io.pos()
- if ((self._io.is_eof()) or (_.block_type == self._root.BlockType.end_of_file)) :
- break
- i += 1
- self._debug['blocks']['end'] = self._io.pos()
-
- class ImageData(KaitaiStruct):
- """
- .. seealso::
- - section 22 - https://www.w3.org/Graphics/GIF/spec-gif89a.txt
- """
- SEQ_FIELDS = ["lzw_min_code_size", "subblocks"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['lzw_min_code_size']['start'] = self._io.pos()
- self.lzw_min_code_size = self._io.read_u1()
- self._debug['lzw_min_code_size']['end'] = self._io.pos()
- self._debug['subblocks']['start'] = self._io.pos()
- self.subblocks = self._root.Subblocks(self._io, self, self._root)
- self.subblocks._read()
- self._debug['subblocks']['end'] = self._io.pos()
-
-
- class ColorTableEntry(KaitaiStruct):
- SEQ_FIELDS = ["red", "green", "blue"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['red']['start'] = self._io.pos()
- self.red = self._io.read_u1()
- self._debug['red']['end'] = self._io.pos()
- self._debug['green']['start'] = self._io.pos()
- self.green = self._io.read_u1()
- self._debug['green']['end'] = self._io.pos()
- self._debug['blue']['start'] = self._io.pos()
- self.blue = self._io.read_u1()
- self._debug['blue']['end'] = self._io.pos()
-
-
- class LogicalScreenDescriptorStruct(KaitaiStruct):
- """
- .. seealso::
- - section 18 - https://www.w3.org/Graphics/GIF/spec-gif89a.txt
- """
- SEQ_FIELDS = ["screen_width", "screen_height", "flags", "bg_color_index", "pixel_aspect_ratio"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['screen_width']['start'] = self._io.pos()
- self.screen_width = self._io.read_u2le()
- self._debug['screen_width']['end'] = self._io.pos()
- self._debug['screen_height']['start'] = self._io.pos()
- self.screen_height = self._io.read_u2le()
- self._debug['screen_height']['end'] = self._io.pos()
- self._debug['flags']['start'] = self._io.pos()
- self.flags = self._io.read_u1()
- self._debug['flags']['end'] = self._io.pos()
- self._debug['bg_color_index']['start'] = self._io.pos()
- self.bg_color_index = self._io.read_u1()
- self._debug['bg_color_index']['end'] = self._io.pos()
- self._debug['pixel_aspect_ratio']['start'] = self._io.pos()
- self.pixel_aspect_ratio = self._io.read_u1()
- self._debug['pixel_aspect_ratio']['end'] = self._io.pos()
-
- @property
- def has_color_table(self):
- if hasattr(self, '_m_has_color_table'):
- return self._m_has_color_table if hasattr(self, '_m_has_color_table') else None
-
- self._m_has_color_table = (self.flags & 128) != 0
- return self._m_has_color_table if hasattr(self, '_m_has_color_table') else None
-
- @property
- def color_table_size(self):
- if hasattr(self, '_m_color_table_size'):
- return self._m_color_table_size if hasattr(self, '_m_color_table_size') else None
-
- self._m_color_table_size = (2 << (self.flags & 7))
- return self._m_color_table_size if hasattr(self, '_m_color_table_size') else None
-
-
- class LocalImageDescriptor(KaitaiStruct):
- SEQ_FIELDS = ["left", "top", "width", "height", "flags", "local_color_table", "image_data"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['left']['start'] = self._io.pos()
- self.left = self._io.read_u2le()
- self._debug['left']['end'] = self._io.pos()
- self._debug['top']['start'] = self._io.pos()
- self.top = self._io.read_u2le()
- self._debug['top']['end'] = self._io.pos()
- self._debug['width']['start'] = self._io.pos()
- self.width = self._io.read_u2le()
- self._debug['width']['end'] = self._io.pos()
- self._debug['height']['start'] = self._io.pos()
- self.height = self._io.read_u2le()
- self._debug['height']['end'] = self._io.pos()
- self._debug['flags']['start'] = self._io.pos()
- self.flags = self._io.read_u1()
- self._debug['flags']['end'] = self._io.pos()
- if self.has_color_table:
- self._debug['local_color_table']['start'] = self._io.pos()
- self._raw_local_color_table = self._io.read_bytes((self.color_table_size * 3))
- io = KaitaiStream(BytesIO(self._raw_local_color_table))
- self.local_color_table = self._root.ColorTable(io, self, self._root)
- self.local_color_table._read()
- self._debug['local_color_table']['end'] = self._io.pos()
-
- self._debug['image_data']['start'] = self._io.pos()
- self.image_data = self._root.ImageData(self._io, self, self._root)
- self.image_data._read()
- self._debug['image_data']['end'] = self._io.pos()
-
- @property
- def has_color_table(self):
- if hasattr(self, '_m_has_color_table'):
- return self._m_has_color_table if hasattr(self, '_m_has_color_table') else None
-
- self._m_has_color_table = (self.flags & 128) != 0
- return self._m_has_color_table if hasattr(self, '_m_has_color_table') else None
-
- @property
- def has_interlace(self):
- if hasattr(self, '_m_has_interlace'):
- return self._m_has_interlace if hasattr(self, '_m_has_interlace') else None
-
- self._m_has_interlace = (self.flags & 64) != 0
- return self._m_has_interlace if hasattr(self, '_m_has_interlace') else None
-
- @property
- def has_sorted_color_table(self):
- if hasattr(self, '_m_has_sorted_color_table'):
- return self._m_has_sorted_color_table if hasattr(self, '_m_has_sorted_color_table') else None
-
- self._m_has_sorted_color_table = (self.flags & 32) != 0
- return self._m_has_sorted_color_table if hasattr(self, '_m_has_sorted_color_table') else None
-
- @property
- def color_table_size(self):
- if hasattr(self, '_m_color_table_size'):
- return self._m_color_table_size if hasattr(self, '_m_color_table_size') else None
-
- self._m_color_table_size = (2 << (self.flags & 7))
- return self._m_color_table_size if hasattr(self, '_m_color_table_size') else None
-
-
- class Block(KaitaiStruct):
- SEQ_FIELDS = ["block_type", "body"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['block_type']['start'] = self._io.pos()
- self.block_type = KaitaiStream.resolve_enum(self._root.BlockType, self._io.read_u1())
- self._debug['block_type']['end'] = self._io.pos()
- self._debug['body']['start'] = self._io.pos()
- _on = self.block_type
- if _on == self._root.BlockType.extension:
- self.body = self._root.Extension(self._io, self, self._root)
- self.body._read()
- elif _on == self._root.BlockType.local_image_descriptor:
- self.body = self._root.LocalImageDescriptor(self._io, self, self._root)
- self.body._read()
- self._debug['body']['end'] = self._io.pos()
-
-
- class ColorTable(KaitaiStruct):
- """
- .. seealso::
- - section 19 - https://www.w3.org/Graphics/GIF/spec-gif89a.txt
- """
- SEQ_FIELDS = ["entries"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['entries']['start'] = self._io.pos()
- self.entries = []
- i = 0
- while not self._io.is_eof():
- if not 'arr' in self._debug['entries']:
- self._debug['entries']['arr'] = []
- self._debug['entries']['arr'].append({'start': self._io.pos()})
- _t_entries = self._root.ColorTableEntry(self._io, self, self._root)
- _t_entries._read()
- self.entries.append(_t_entries)
- self._debug['entries']['arr'][len(self.entries) - 1]['end'] = self._io.pos()
- i += 1
-
- self._debug['entries']['end'] = self._io.pos()
-
-
- class Header(KaitaiStruct):
- """
- .. seealso::
- - section 17 - https://www.w3.org/Graphics/GIF/spec-gif89a.txt
- """
- SEQ_FIELDS = ["magic", "version"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['magic']['start'] = self._io.pos()
- self.magic = self._io.ensure_fixed_contents(b"\x47\x49\x46")
- self._debug['magic']['end'] = self._io.pos()
- self._debug['version']['start'] = self._io.pos()
- self.version = (self._io.read_bytes(3)).decode(u"ASCII")
- self._debug['version']['end'] = self._io.pos()
-
-
- class ExtGraphicControl(KaitaiStruct):
- """
- .. seealso::
- - section 23 - https://www.w3.org/Graphics/GIF/spec-gif89a.txt
- """
- SEQ_FIELDS = ["block_size", "flags", "delay_time", "transparent_idx", "terminator"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['block_size']['start'] = self._io.pos()
- self.block_size = self._io.ensure_fixed_contents(b"\x04")
- self._debug['block_size']['end'] = self._io.pos()
- self._debug['flags']['start'] = self._io.pos()
- self.flags = self._io.read_u1()
- self._debug['flags']['end'] = self._io.pos()
- self._debug['delay_time']['start'] = self._io.pos()
- self.delay_time = self._io.read_u2le()
- self._debug['delay_time']['end'] = self._io.pos()
- self._debug['transparent_idx']['start'] = self._io.pos()
- self.transparent_idx = self._io.read_u1()
- self._debug['transparent_idx']['end'] = self._io.pos()
- self._debug['terminator']['start'] = self._io.pos()
- self.terminator = self._io.ensure_fixed_contents(b"\x00")
- self._debug['terminator']['end'] = self._io.pos()
-
- @property
- def transparent_color_flag(self):
- if hasattr(self, '_m_transparent_color_flag'):
- return self._m_transparent_color_flag if hasattr(self, '_m_transparent_color_flag') else None
-
- self._m_transparent_color_flag = (self.flags & 1) != 0
- return self._m_transparent_color_flag if hasattr(self, '_m_transparent_color_flag') else None
-
- @property
- def user_input_flag(self):
- if hasattr(self, '_m_user_input_flag'):
- return self._m_user_input_flag if hasattr(self, '_m_user_input_flag') else None
-
- self._m_user_input_flag = (self.flags & 2) != 0
- return self._m_user_input_flag if hasattr(self, '_m_user_input_flag') else None
-
-
- class Subblock(KaitaiStruct):
- SEQ_FIELDS = ["num_bytes", "bytes"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['num_bytes']['start'] = self._io.pos()
- self.num_bytes = self._io.read_u1()
- self._debug['num_bytes']['end'] = self._io.pos()
- self._debug['bytes']['start'] = self._io.pos()
- self.bytes = self._io.read_bytes(self.num_bytes)
- self._debug['bytes']['end'] = self._io.pos()
-
-
- class ExtApplication(KaitaiStruct):
- SEQ_FIELDS = ["application_id", "subblocks"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['application_id']['start'] = self._io.pos()
- self.application_id = self._root.Subblock(self._io, self, self._root)
- self.application_id._read()
- self._debug['application_id']['end'] = self._io.pos()
- self._debug['subblocks']['start'] = self._io.pos()
- self.subblocks = []
- i = 0
- while True:
- if not 'arr' in self._debug['subblocks']:
- self._debug['subblocks']['arr'] = []
- self._debug['subblocks']['arr'].append({'start': self._io.pos()})
- _t_subblocks = self._root.Subblock(self._io, self, self._root)
- _t_subblocks._read()
- _ = _t_subblocks
- self.subblocks.append(_)
- self._debug['subblocks']['arr'][len(self.subblocks) - 1]['end'] = self._io.pos()
- if _.num_bytes == 0:
- break
- i += 1
- self._debug['subblocks']['end'] = self._io.pos()
-
-
- class Subblocks(KaitaiStruct):
- SEQ_FIELDS = ["entries"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['entries']['start'] = self._io.pos()
- self.entries = []
- i = 0
- while True:
- if not 'arr' in self._debug['entries']:
- self._debug['entries']['arr'] = []
- self._debug['entries']['arr'].append({'start': self._io.pos()})
- _t_entries = self._root.Subblock(self._io, self, self._root)
- _t_entries._read()
- _ = _t_entries
- self.entries.append(_)
- self._debug['entries']['arr'][len(self.entries) - 1]['end'] = self._io.pos()
- if _.num_bytes == 0:
- break
- i += 1
- self._debug['entries']['end'] = self._io.pos()
-
-
- class Extension(KaitaiStruct):
- SEQ_FIELDS = ["label", "body"]
- def __init__(self, _io, _parent=None, _root=None):
- self._io = _io
- self._parent = _parent
- self._root = _root if _root else self
- self._debug = collections.defaultdict(dict)
-
- def _read(self):
- self._debug['label']['start'] = self._io.pos()
- self.label = KaitaiStream.resolve_enum(self._root.ExtensionLabel, self._io.read_u1())
- self._debug['label']['end'] = self._io.pos()
- self._debug['body']['start'] = self._io.pos()
- _on = self.label
- if _on == self._root.ExtensionLabel.application:
- self.body = self._root.ExtApplication(self._io, self, self._root)
- self.body._read()
- elif _on == self._root.ExtensionLabel.comment:
- self.body = self._root.Subblocks(self._io, self, self._root)
- self.body._read()
- elif _on == self._root.ExtensionLabel.graphic_control:
- self.body = self._root.ExtGraphicControl(self._io, self, self._root)
- self.body._read()
- else:
- self.body = self._root.Subblocks(self._io, self, self._root)
- self.body._read()
- self._debug['body']['end'] = self._io.pos()
-
-
-