"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libview2' }"

ImageReader subclass:#WindowsIconReader

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	category:'Graphics-Images-Readers'

!

!WindowsIconReader class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    this class provides methods for loading Windows and OS2 icon files.

    Image writing is only supported for BMP format with depth 1,4,8 and 24 bit images.

    The reader tries to figure out which version of BMP/ICO is used.

    It seems to be able to load most formats, but who knows ...

    The class name *IconReader is a bad, historic choice - it ws originally

    written to read icons only, but evolved over time and it should now be also

    capapble of reading bmp and cursor files.

    [See also:]

        Image Form Icon

        BlitImageReader FaceReader GIFReader JPEGReader PBMReader PCXReader 

        ST80FormReader SunRasterReader TargaReader TIFFReader  

        XBMReader XPMReader XWDReader 

"

!

fileFormatDescription

"

    Information from http://www.daubnet.com/formats/BMP.html - no Warranty.

          Name           Size                Description

      Header            14 bytes            Windows Structure: BITMAPFILEHEADER

          Signature      2 bytes             'BM'

          FileSize       4 bytes             File size in bytes

          reserved       4 bytes             unused (=0)

          DataOffset     4 bytes             File offset to Raster Data

      InfoHeader        40 bytes            Windows Structure: BITMAPINFOHEADER

          Size           4 bytes             Size of InfoHeader =40 

          Width          4 bytes             Bitmap Width

          Height         4 bytes             Bitmap Height

          Planes         2 bytes             Number of Planes (=1)

          BitCount       2 bytes             Bits per Pixel   

                                             1 = monochrome palette. NumColors = 1   

                                             4 = 4bit palletized. NumColors = 16   

                                             8 = 8bit palletized. NumColors = 256  

                                             16 = 16bit RGB. NumColors = 65536 (?)  

                                             24 = 24bit RGB. NumColors = 16M

          Compression    4 bytes             Type of Compression   

                                             0 = BI_RGB   no compression   

                                             1 = BI_RLE8 8bit RLE encoding   

                                             2 = BI_RLE4 4bit RLE encoding

          ImageSize      4 bytes             (compressed) Size of Image  

                                             It is valid to set this =0 if Compression = 0

          XpixelsPerM    4 bytes             horizontal resolution: Pixels/meter

          YpixelsPerM    4 bytes             vertical resolution: Pixels/meter

          ColorsUsed     4 bytes             Number of actually used colors

          ColorsImportant

                         4 bytes             Number of important colors  

                                             0 = all

       ColorTable        4 * NumColors bytes

                                             present only if Info.BitsPerPixel <= 8   

                                             colors should be ordered by importance

            Red           1 byte              Red intensity

            Green         1 byte              Green intensity

            Blue          1 byte              Blue intensity

            reserved      1 byte             unused (=0)

          repeated NumColors times

       Raster Data      Info.ImageSize bytes     The pixel data

Raster Data encoding:

       Depending on the image's BitCount and on the Compression flag there are 6 different encoding schemes. 

       All of them share the following:  

       Pixels are stored bottom-up, left-to-right. Pixel lines are padded with zeros to end on a 32bit (4byte) boundary. For

       uncompressed formats every line will have the same number of bytes. Color indices are zero based, meaning a pixel

       color of 0 represents the first color table entry, a pixel color of 255 (if there are that many) represents the 256th entry.

       For images with more than 256 colors there is no color table. 

Raster Data encoding for 1bit / black & white images:

       BitCount = 1 Compression = 0  

       Every byte holds 8 pixels, its highest order bit representing the leftmost pixel of those. There are 2 color table entries.

       Some readers will ignore them though, and assume that 0 is black and 1 is white. If you are storing black and white

       pictures you should stick to this, with any other 2 colors this is not an issue. Remember padding with zeros up to a

       32bit boundary (This can be up to 31 zeros/pixels!!)                                                                 

Raster Data encoding for 4bit / 16 color images:

       BitCount = 4 Compression = 0  

       Every byte holds 2 pixels, its high order 4 bits representing the left of those. There are 16 color table entries. These

       colors do not have to be the 16 MS-Windows standard colors. Padding each line with zeros up to a 32bit boundary

       will result in up to 28 zeros = 7 'wasted pixels'.

Raster Data encoding for 8bit / 256 color images:

       BitCount = 8 Compression = 0  

       Every byte holds 1 pixel. There are 256 color table entries. Padding each line with zeros up to a 32bit boundary will

       result in up to 3 bytes of zeros = 3 'wasted pixels'.

Raster Data encoding for 16bit / hicolor images:

       BitCount = 16 Compression = 0  

       Every 2bytes / 16bit holds 1 pixel.   

       <information missing: the 16 bit was introduced together with Video For Windows? Is it a memory-only-format?>  

       The pixels are no color table pointers. There are no color table entries. Padding each line with zeros up to a 16bit

       boundary will result in up to 2 zero bytes.

Raster Data encoding for 24bit / truecolor images:

       BitCount = 24 Compression = 0  

       Every 4bytes / 32bit holds 1 pixel. The first holds its red, the second its green, and the third its blue intensity. The

       fourth byte is reserved and should be zero. There are no color table entries. The pixels are no color table pointers. No

       zero padding necessary.

Raster Data compression for 4bit / 16 color images:

       BitCount = 4 Compression = 2  

       The pixel data is stored in 2bytes / 16bit chunks.  The first of these specifies the number of consecutive pixels with the

       same pair of color. The second byte defines two color indices. The resulting pixel pattern will be interleaved

       high-order 4bits and low order 4 bits (ABABA...). If the first byte is zero, the second defines an escape code. The

       End-of-Bitmap is zero padded to end on a 32bit boundary. Due to the 16bit-ness of this structure this will always be

       either two zero bytes or none.   

        n (byte 1) c (Byte 2)                                       Description

        >0        any      n pixels are to be drawn. The 1st, 3rd, 5th, ... pixels' color is in c's high-order 4 bits, the even

                            pixels' color is in c's low-order 4 bits. If both color indices are the same, it results in just n

                            pixels of color c

        0         0        End-of-line

        0         1        End-of-Bitmap

        0         2        Delta. The following 2 bytes define an unsigned offset in x and y direction (y being up) The

                            skipped pixels should get a color zero.

        0         >=3      The following c bytes will be read as single pixel colors just as in uncompressed files. up to 12

                            bits of zeros follow, to put the file/memory pointer on a 16bit boundary again.

                                      Example for 4bit RLE

        Compressed Data                           Expanded data

        03 04              0 4 0

        05 06              0 6 0 6 0

        00 06 45 56 67 00  4 5 5 6 6 7

        04 78              7 8 7 8

        00 02 05 01        Move 5 right and 1 up. (Windows docs say down, which is wrong)

        00 00              End-of-line

        09 1E              1 E 1 E 1 E 1 E 1

        00 01              EndofBitmap

        00 00              Zero padding for 32bit boundary

Raster Data compression for 8bit / 256 color images:

       BitCount = 8 Compression = 1  

       The pixel data is stored in 2bytes / 16bit chunks.  The first of these specifies the number of consecutive pixels with the

       same color. The second byte defines their color index. If the first byte is zero, the second defines an escape code. The

       End-of-Bitmap is zero padded to end on a 32bit boundary. Due to the 16bit-ness of this structure this will always be

       either two zero bytes or none.   

        n (byte 1)   c (Byte 2)                                    Description

        >0       any        n pixels of color number c

        0        0          End-of-line

        0        1          End Of Bitmap

        0        2          Delta. The following 2 bytes define an unsigned offset in x and y direction (y being up) The

                            skipped pixels should get a color zero.

        0        >=3        The following c bytes will be read as single pixel colors just as in uncompressed files. A zero

                            follows, if c is odd, putting the file/memory pointer on a 16bit boundary again.

                                      Example for 8bit RLE

        Compressed Data                           Expanded data

        03 04              04 04 04

        05 06              06 06 06 06 06

        00 03 45 56 67 00  45 56 67

        02 78              78 78

        00 02 05 01        Move 5 right and 1 up. (Windows docs say down, which is wrong)

        00 00              End-of-line

        09 1E              1E 1E 1E 1E 1E 1E 1E 1E 1E

        00 01              End-of-bitmap

        00 00              Zero padding for 32bit boundary

Portability:

       Although BMPs were invented by Microsoft for its Windows platform, a lot of programs on other platforms are capable

       of reading and writing them. Notice the Intel order in 2byte and 4-byte integer values (Least significant byte first). The

       16bit BMPs have been introduced to Windows after the others, still puzzling many applications.

Trademarks, Patents and Royalties

       To my knowledge: None.  

"

! !

!WindowsIconReader class methodsFor:'initialization'!

initialize

    "tell Image-class, that a new fileReader is present

     for the '.bmp' and '.ico' extensions."

    MIMETypes defineImageType:'image/x-MS-bitmap' suffix:'bmp' reader:self.

    MIMETypes defineImageType:nil                 suffix:'ico' reader:self.

    "Modified: 1.2.1997 / 15:03:59 / cg"

! !

!WindowsIconReader class methodsFor:'testing'!

canRepresent:anImage

    "return true, if anImage can be represented in my file format.

     BMP supports depth 1,4,8 and 24."

    ^ (#(1 4 8 24) includes:anImage depth)

    "Created: 17.10.1997 / 20:18:23 / cg"

!

isValidImageFile:aFileName

    "return true, if aFileName contains a valid windows bitmap-file image"

    |inStream header ok|

    inStream := self streamReadingFile:aFileName.

    inStream isNil ifTrue:[^ false].

    inStream binary.

    ok := false.

    inStream fileSize > 16 ifTrue:[

        header := ByteArray uninitializedNew:4.

        inStream nextBytes:4 into:header.

        (header startsWith:#(66 77)) ifTrue:[     "BM"

            ok := true.

"/            'WINREADER: Win3.x or OS/2 vsn 2 BM format' infoPrintNL.

        ].

        (header startsWith:#(66 65)) ifTrue:[     "BA"

            ok := true.

"/            'WINREADER: OS/2 vsn 2 BA format' infoPrintNL.

        ].

        (header startsWith:#(73 67)) ifTrue:[     "IC"

            ok := true.

"/            'WINREADER: OS/2 IC format' infoPrintNL.

        ].

        (header startsWith:#(80 84)) ifTrue:[     "PT"

            ok := true.

"/            'WINREADER: OS/2 PT format' infoPrintNL.

        ].

        (header startsWith:#(0 0 1 0)) ifTrue:[

            ok := true.

"/            'WINREADER: Win3.x ICO format' infoPrintNL.

        ].

    ].

    inStream close.

    ^ ok

    "

     WindowsIconReader isValidImageFile:'/phys/clam2/LocalLibrary/Images/OS2_icons/dos.ico'

    "

    "Created: 17.9.1995 / 17:14:20 / claus"

! !

!WindowsIconReader methodsFor:'private'!

loadBMPWidth:w height:h depth:d compression:c from:aStream into:data

    "helper: load a BMP image"

    |buff idx fileBytesPerRow imgBytesPerRow|

    d == 8 ifTrue:[

        (self class loadBMP8Width:w height:h compression:c from:aStream into:data) ifFalse:[

            self fileFormatError:'read/decompression failed'.

            ^ false

        ].

        ^ true

    ].

    d == 4 ifTrue:[

        (self class loadBMP4to8Width:w height:h compression:c from:aStream into:data) ifFalse:[

            self fileFormatError:'read/decompression failed'.

            ^ false

        ].

        ^ true

    ].

    d == 2 ifTrue:[

        (self class loadBMP2to8Width:w height:h from:aStream into:data) ifFalse:[

            self fileFormatError:'read failed'.

            ^ false

        ].

        ^ true

    ].

    d == 1 ifTrue:[

        (self class loadBMP1to8Width:w height:h from:aStream into:data) ifFalse:[

            self fileFormatError:'read failed'.

            ^ false

        ].

        ^ true

    ].

    d == 24 ifTrue:[

        imgBytesPerRow := w * 3.

        fileBytesPerRow := imgBytesPerRow.

        (fileBytesPerRow bitAnd:3) ~~ 0 ifTrue:[

            fileBytesPerRow := (fileBytesPerRow bitAnd:(3 bitInvert)) + 4.

        ].

        "/

        "/ stupid - last row comes first

        "/

        idx := imgBytesPerRow * (height - 1) + 1.

        buff := ByteArray uninitializedNew:fileBytesPerRow.

        1 to:height do:[:row |

            (aStream nextBytes:fileBytesPerRow into:buff) ~~ fileBytesPerRow ifTrue:[

                self fileFormatError:'read failed'.

                ^ false

            ].

            data replaceFrom:idx to:idx+imgBytesPerRow-1 with:buff.

            idx := idx - imgBytesPerRow.

        ].

        ^ true

    ].

    self fileFormatError:('unsupported depth:' , d printString).

    ^ false

    "Created: / 17.9.1995 / 18:48:11 / claus"

    "Modified: / 3.2.1998 / 20:21:16 / cg"

! !

!WindowsIconReader methodsFor:'private-reading'!

readColorMap:nColors numBytesPerColor:nRawBytesPerColor from:aStream

    "read the colormap; notice: its in BGR order (sigh)."

    |rawMap rMap gMap bMap 

     srcIndex  "{ Class: SmallInteger }"

     skipDelta "{ Class: SmallInteger }"|

    rawMap := ByteArray uninitializedNew:(nColors*nRawBytesPerColor).

    aStream nextBytes:(nColors*nRawBytesPerColor) into:rawMap.

    rMap := ByteArray new:nColors.

    gMap := ByteArray new:nColors.

    bMap := ByteArray new:nColors.

    srcIndex := 1.

    skipDelta := nRawBytesPerColor - 3.

    "/ stupid: this is a BGR-ordered map (otherwise, could use #rgbBytesVector:-message)

    "/ also, there might be a fourth byte (alpha ?) which is (currently) skipped.

    1 to:nColors do:[:i |

        bMap at:i put:(rawMap at:srcIndex).

        srcIndex := srcIndex + 1.

        gMap at:i put:(rawMap at:srcIndex).

        srcIndex := srcIndex + 1.

        rMap at:i put:(rawMap at:srcIndex).

        srcIndex := srcIndex + 1.

        srcIndex := srcIndex + skipDelta.

    ].

    ^ MappedPalette 

        redVector:rMap 

        greenVector:gMap 

        blueVector:bMap.

! !

!WindowsIconReader methodsFor:'reading'!

fromOS2File:aFilename

    "read an image from an OS/2 BMP file"

    |reader stream|

    stream := self class streamReadingFile:aFilename.

    stream isNil ifTrue:[^ nil].

    reader := (self class new) fromOS2Stream:stream.

    stream close.

    reader notNil ifTrue:[^ reader image].

    ^ nil

    "Modified: 23.4.1996 / 13:09:28 / cg"

!

fromOS2Stream:aStream

    "read an image from an OS/2 BMP stream"

    |header inDepth inBytesPerRow mask bytesPerRow nColors nByte|

    inStream := aStream.

    aStream binary.

    byteOrder := #lsb.

    "read the header"

    header := ByteArray uninitializedNew:8r110.

    aStream nextBytes:16 into:header.

    (header startsWith:#(73 67)) ifTrue:[         "IC"

        "IC format"

        aStream nextBytes:10 into:header startingAt:17.

        width := header at:7.

        height := header at:9.

        inDepth := 2 "header at:11". "where is it"

    ] ifFalse:[

        (header startsWith:#(67 73)) ifTrue:[     "CI"

            ^ self fileFormatError:'unsupported format: CI'.

        ] ifFalse:[

            aStream nextBytes:(8r110-16) into:header startingAt:17.

            width := header at:8r101.

            height := header at:8r103.

            inDepth := header at:8r107.

        ]

    ].

    self reportDimension.

    "read the colormap; notice: its in BGR order (sigh)"

    nColors := 1 bitShift:inDepth.

    colorMap := self readColorMap:nColors numBytesPerColor:3 from:aStream.

    "read the mask"

    nByte := width * height + 7 // 8.

    mask := ByteArray uninitializedNew:nByte.

    aStream nextBytes:nByte into:mask.

    "what is this ?"

    aStream nextBytes:nByte into:mask.

"/    "read the data bits"

"/

"/    bytesPerRow := width * inDepth + 7 // 8.

"/    data4 := ByteArray uninitializedNew:(height * bytesPerRow).

"/    inDepth == 8 ifTrue:[

"/    ].

"/    aStream nextBytes:(height * bytesPerRow) into:data4.

"/

"/    "stupid: last row first"

"/

"/    tmp := ByteArray new:(height * bytesPerRow).

"/    srcIndex := 1.

"/    dstIndex := (height - 1) * bytesPerRow + 1.

"/    1 to:height do:[:row |

"/        tmp replaceFrom:dstIndex to:(dstIndex + bytesPerRow - 1)

"/                   with:data4 startingAt:srcIndex.

"/        srcIndex := srcIndex + bytesPerRow.

"/        dstIndex := dstIndex - bytesPerRow.

"/    ].

"/    data4 := tmp.

"/

"/    "expand into bytes"

"/

"/    data := ByteArray new:(width * height).

"/    data4 expandPixels:inDepth width:width height:height

"/                  into:data mapping:nil.

"/

    bytesPerRow := width * inDepth + 7 // 8.

    "/ bmp data is always 32bit aligned; if required,