ppbin

Pretty-printer for binary file.

License

zlib License.

Target environments

Windows, Cygwin, Linux, macOS, FreeBSD.

ppbin is Python 3.8 script, and so probably works fine on other OS.

Set up

1. Install Python 3.8.10 or later.
2. Put ppbin in a directory registered in PATH.

Usage

Please check help message ppbin --help

Example

$ # -n 20 --> 20 words in 1 line
$ # -w 1  --> 1 word == 1 octet
$ ppbin -n 20 -w 1 test.bin
52 49 46 46 24 00 00 00 57 41 56 45 66 6D 74 20 10 00 00 00
01 00 02 00 44 AC 00 00 10 B1 02 00 04 00 10 00 64 61 74 61
00 00 00 00
$
$ # -n 4 --> 4 words in 1 line
$ # -w 4 --> 1 word == 4 octet
$ ppbin -n 4 -w 4 test.bin
52494646 24000000 57415645 666D7420
10000000 01000200 44AC0000 10B10200
04001000 64617461 00000000
$
$ # -l --> interpret as little-endian
$ ppbin -l -n 4 -w 4 test.bin
46464952 00000024 45564157 20746D66
00000010 00020001 0000AC44 0002B110
00100004 61746164 00000000
$
$ # -p 2 --> 1 print-word == 2 octet (print 2 octet at a time)
$ # -w 4 --> 1 word == 4 octet
$ ppbin -l -n 4 -p 2 -w 4 test.bin
4646 4952 0000 0024 4556 4157 2074 6D66
0000 0010 0002 0001 0000 AC44 0002 B110
0010 0004 6174 6164 0000 0000
$
$ # C-style print with 2-space indentation.
$ # -a 0x   --> add prefix `0x' to each print-words
$ # -d ', ' --> delimiter is ', '
$ # -i 2    --> indent size is 2
$ ppbin -a 0x -d ', ' -i 2 -l -n 4 -w 4 test.bin
  0x46464952, 0x00000024, 0x45564157, 0x20746D66,
  0x00000010, 0x00020001, 0x0000AC44, 0x0002B110,
  0x00100004, 0x61746164, 0x00000000,
$
$ # 1-tab indentation.
$ # -i 1 --> indent size is 1
$ # -t   --> use tab insted of space
$ ppbin -a 0x -d ', ' -i 1 -l -n 4 -t -w 4 test.bin
        0x46464952, 0x00000024, 0x45564157, 0x20746D66,
        0x00000010, 0x00020001, 0x0000AC44, 0x0002B110,
        0x00100004, 0x61746164, 0x00000000,
$
$ # -b <header> --> add header
$ # -e <footer> --> add footer
$ ppbin -a 0x -b 'static const uint32_t test_bin[] = {' \
>       -d ', ' -e '};' -i 1 -l -n 4 -t -w 4 test.bin
static const uint32_t test_bin[] = {
        0x46464952, 0x00000024, 0x45564157, 0x20746D66,
        0x00000010, 0x00020001, 0x0000AC44, 0x0002B110,
        0x00100004, 0x61746164, 0x00000000,
};
$
$ # -A '"'   --> add prefix `"' to each words
$ # -D '", ' --> partially overwrite delimiter
$ ppbin -A '"' -a \\x -b 'static const char * const test_bin[] = {' \
>       -d '' -D '", ' -e '};' -i 1 -l -n 2 -p 1 -t -w 4 test.bin
static const char * const test_bin[] = {
        "\x46\x46\x49\x52", "\x00\x00\x00\x24",
        "\x45\x56\x41\x57", "\x20\x74\x6D\x66",
        "\x00\x00\x00\x10", "\x00\x02\x00\x01",
        "\x00\x00\xAC\x44", "\x00\x02\xB1\x10",
        "\x00\x10\x00\x04", "\x61\x74\x61\x64",
        "\x00\x00\x00\x00",
};
$
$ _