pysimg

Pure-Python tools for handling Android fastboot's sparse image format.

Essentially, the sparse image format is a very simple form of compression which can skip over unpopulated space in images (DONT_CARE) or repeated 4-byte sequences (FILL).

img2simg

img2simg converts raw disk images to Android's sparse image format. Features:

• Unlike the official img2simg, this version doesn't seek in the input file, so it can be used (for example) to sparsify a raw disk image streamed from a decompressor.
• It can split images into multiple sparse images of no more than a certain size (specified in MiB with --split MiB). Each of the images is pre- and post-padding with DONT_CARE blocks, to align with the full image size. (The only other publicly-available tool I know of that can do this is SparseConverter).
• It can replace real data patterns with DONT_CARE (e.g. -D 00000000 or -D FFFFFFFF). This should never be used on real images unless it is known that the image flash will be preceded by fastboot erase or something else that leaves the whole memory in a known state.

Available options:

usage: img2simg [-h] [-b BLOCKSIZE] [-o OUTPUT] [-S MiB] [-d] img

positional arguments:
  img

optional arguments:
  -h, --help            show this help message and exit
  -b BLOCKSIZE, --blocksize BLOCKSIZE
                        Sparse block size (default 4096)
  -o PATH, --output PATH
                        Output file (default is standard output)
  -S MiB, --split MiB   Split output into multiple sparse images of no more
                        than the specified size in MiB (= 2**20 bytes)
  -D PATTERN, --dont-care PATTERN
                        Hex pattern (e.g. FFFFFFFF) to treat as DONT_CARE; may
                        be specified multiple times
  -d, --debug

Disclaimer

Use at your own risk.

I've verified that this Python version outputs bit-identical images to the official img2simg for many real-world cases, when used in its default mode (no splitting or DONT_CARE replacement).

Author

© Daniel Lenski <[email protected]> (2017)

License

GPL v3 or later