Compressed image format
Images written on the keychain by the Photoviewer application are stored in a compressed form. This section describes the compressed image format.
NOTE: code for reading images from a ST2205-based picture photoframe has been included now (march 2010) in gphoto SVN, see UsingAsPicframe
The photo keychain can contain several images. A simple directory-like structure starting at address 0 contains pointers to where the actual compressed images are stored.
Basic principles used in the encoding:
- 8x8 image blocks: an image has a dimension of 128x128 pixels and is subdivided into 256 blocks of 8x8 pixels each.
- YUV-like encoding: each of these 8x8 pixel blocks is separated into a brightness component and two color components and independently encoded by a lossy compression algorithm.
- block shuffling: the order in which the blocks are encoded is usually not simply linear top-down left-right, but is controlled by one of several "shuffling tables" that determine where each decoded block goes into the final image. By showing the decoding process in real time and using a different shuffling table for each picture, the photo key chain can create various transition effects between the previously decoded photo and the currently decoding photo.
Note the above (and below) 128x128 resolution and thus 256 blocks assumes a frame with a lcd a resolution of 128x128, for displays with a different reslution this numbers change accordingly.
An image is encoded as a 16-byte image header, followed by the 256 blocks encoding each for an area of 8x8 pixels. Typically, each 8x8 block is encoded using 48 bytes (or in some special cases 56 or 64 bytes, see below), this means a total size of 12304 bytes. Uncompressed, the image would require 32768 bytes (assuming 16-bit RGB565 format), saving space by a factor of about 2.66.
An image starts with a 16-byte header:
|0x00||Image marker with a fixed value of 0xF5|
|0x01/0x02||Image width (0x80) encoded as big-endian|
|0x03/0x04||Image height (0x80) encoded as big-endian|
|0x05/0x06||Number of 8x8 blocks in the image (0x100) encoded as big-endian|
|0x07||Shuffle pattern to use|
|0x08||Unknown, bits 1 and 2 carry some special meaning. Usually contains value 0x04.|
|0x09||Related to block shuffling, exact meaning unknown. Contain 0xFF for shuffle pattern 1, for other shuffle patterns it contains a value depending on the picture frame resolution. For 128x128 frames it contains 1, for 96x64 frames it contains 0.|
|0x0A/0x0B||Length of following image data|
|0x0C-0x0F||Padding/unused (all 0x00)|
8x8 pixel block
The 8x8 pixel block is encoded further as a variable length block, as follows:
|0x00||Length byte||Bit 0-6 is the length of the rest of the block (often 0x2F). Bit 7 selects between 2-bit and 4-bit luma decoding mode|
|0x01||Luma Y byte||Bit 0-6 is the base offset of the luminance channel for every pixel in the block. Bit 7 selects between two luminance patterns tables (LUMA1 or LUMA2)|
|0x02||Chroma U byte||Bit 0-6 is the base offset of the U chrominance channel for every pixel in the block. Bit 7 indicates extended decoding of this chrominance channel|
|0x03||Chroma V byte||Bit 0-6 is the base offset of the V chrominance channel for every pixel in the block. Bit 7 indicates extended decoding of this chrominance channel|
|0x04||Chroma U data||Variable length chrominance channel U decoding info, see below|
|...||Chroma V data||Variable length chrominance channel V decoding info, see below|
|...||Luma Y data||Variable length luminance channel decoding info, see below|
Chrominance is encoded with a reduced resolution of 4x4 "pixels" per block.
The chrominance decoding info consists of:
|0x00||Pattern byte A||Index into a color base pattern table (CHROMA). The table entry contains the pattern for the top 8 chroma pixels.|
|0x01||Pattern byte B||Index into a color base pattern table (CHROMA). The table entry contains the pattern for the bottom 8 chroma pixels.|
|0x02-0x09||Correction||Optional correction items for each chroma pixel (using table CORR). This part is only present when bit7 of the chroma byte is set.|
The chrominance value is basically the sum of:
- chrominance base value (from the chroma U or V byte minus 0x40)
- one of the two base patterns selected from table CHROMA using pattern byte A and B.
- optionally a set of correction values selected from table CORR (very much like luminance)
Chroma pixels in a segment are arranged in the following pattern:
A00 A01 A02 A03 A04 A05 A06 A07 B00 B01 B02 B03 B04 B05 B06 B07
where Axx indicates data looked up using pattern byte A, and Bxx data looked up using pattern byte B.
Note that the chroma info per channel (U and V) is either 2 or 10 bytes, which is why the total block size can be one of 48, 56, or 64 bytes (resp no corr, corr for 1 channel, corr for both channels). By far most blocks are 48 bytes big.
The luminance decoding info consists of:
|0x00-0x07||A set of indexes into table LUMA1 or LUMA2 to select a "base pattern" for each row of pixels inside a block.|
|0x08-0x27||Correction items for each pixel in the block, where each correction item is encoded in 4 bits. Each correction item is actually an index into table CORR storing a value that is added to the luminance value of the pixel.|
In short, the luminance channel of each pixel is basically the sum of:
- luminance base value as encoded in byte 0x01
- one of the base patterns selected from table LUMA1 or LUMA2 using bytes 0x00-0x07 (one byte for one pattern per row of 8 pixels)
- one of the correction values selected from table CORR using the nibbles in bytes 0x08-0x27. This uses one nibble for each pixel, with the high 4 bits (high nibble) of a byte coding the correction for the first pixel that bytes corrects, and the low 4 bits code the correction for the second pixel. The first byte (at offset 0x08), codes the correction for pixel 00 and 01, etc.
Pixels are arranged in the following pattern:
00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F ... 38 39 3A 3B 3C 3D 3E 3F
The color space used in the images is a kind of YUV, using one luminance channel (called Y here) and two chrominance channels (called U and V here), as follows:
R = 2 * (Y + V) G = 2 * (Y - U - V) B = 2 * (Y + U)
Any underflows/overflows during the calculation of the RGB values should be saturated to either 0 or 255 respectively.
And conversely (during encode):
Y = (R + G + B) / 6 U = B/2 - Y V = R/2 - Y
where U and V should be constrained to the range -64 to +63.
Blocks of 8x8 pixels are stored in a shuffled sequence. The choice of the shuffle pattern is stored in byte 0x07 of the image header.
The shuffle pattern is stored in table SHUFFLEx, which contains the (x,y) coordinates of each 8x8 pixel block. Currently there are 7 known shuffle patterns.
Several tables are involved in encoding/decoding. Below is an overview of the various tables, their properties and what they are used for
|LUMA1||256 entries of 8 signed words||Entry contains brightness patterns for 1 row of 8 pixels within an 8x8 block.|
|LUMA2||256 entries of 8 signed words||Entry contains brightness patterns for 1 row of 8 pixels within an 8x8 block. Alternate table.|
|CHROMA||256 entries of 8 signed words||Entry contains chroma patterns for 2 rows of 4 pixels within an 4x4 chroma block.|
|SHUFFLEx||256 entries of 2 bytes||Entry contains the (x,y) coordinates for an 8x8 block. There are several tables like this, each one encoding for a different shuffle pattern.|
|CORR||16 entries of 1 signed word||Correction values that are applied for each pixel. Values in this table: -26,-22,-18,-14,-11,-7,-4,-1,1,4,7,11,14,18,22,26|
The LUMA1, LUMA2 and CHROMA tables are stored inside the picframe in 16 bits signed (2's complement) LE byte order format. LUMA1 starts at 0x8477, LUMA2 at 0x9477, CHROMA at 0xA477. These 3 tables are directly followed at 0xB477 by various shuffle tables, which contain x, y coordinate pairs (1 byte for each). There are a number of sets of shuffle tables, for different display resolutions. There are 8 or 7 tables per set, the first 2 tables are "generated" (0 = row by row, 1 = column by column), then 6 or 5 tables per resolution in ROM:
|Resolution||start||Number of sets in ROM|
|128 x 160||0xB477||6|
|128 x 128||0xC377||5|
|120 x 160||0xCD77||5|
|96 x 64||0xD92F||5|
LCD framebuffer format
For 128x128 screen format, encoding is :
- 2 bytes per pixel
- simple RGB encoding
- one image is 0x8000 bytes (2*128*128)
in binary format the 2 bytes are encoded like that :
- RRRR RGGG GGGB BBBB
- Red use 5 bits, Green 6 bits and blue 5 bits
- a red image is full of f8 00 f8 00 ...
- a green image is full of 07 e0
- a blue image is full of 00 1f
- white pixel is FF FF, black pixel is 00 00
- line 1 pixel 1 is encoded, then line 1 pixel 2 , etc...
image correspondance values
- Red color device=>image conversion
- value can be "11111" (31d to 0d) + "000" (possible value are F8, F0, E8, ...)
- if red value is "abcdef" (binary) red value will be "abcdef000"
- Red color image=>device conversion
- value 00 to FF need to be converted in 5 bits
- if red value is "abcdefxxx" (binary) red value will be "abcdef"
Python program to convert to ppm
for fn in sys.argv[1:]: inf = open(fn) outf = open(fn + ".ppm", "w") outf.write("P6\n128 128\n255\n") for i in range(128*128): aword = inf.read(2) aword = ord(aword) << 8 | ord(aword) red = (aword >> 11) & 0x1f green = (aword >> 5) & 0x3f blue = (aword ) & 0x1f outf.write("%c%c%c" % ( red <<3, green<<2, blue<<3))