"

 COPYRIGHT (c) 2013 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' }"

"{ NameSpace: Smalltalk }"

ImageReader subclass:#MacOSXIconReader

	instanceVariableNames:'image'

	classVariableNames:''

	poolDictionaries:''

	category:'Graphics-Images-Readers'

!

!MacOSXIconReader class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2013 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

"

    Reader/writer for mac osx icon files.

    These files are actually bundles of a sequence of icons (in possibly different resolutions,

    colors and sizes).

    When such a file is read, I return the first image as usual, 

    and all images as an imagesequence.

    Only a subset of the supported image formats are supported by the writer

    (i.e. JPEG and PNG based image encodings only). 

    This means, that only 10.8-and later icon files are really generated.

    [caveat:]

        only a subset of the possibly formats are supported.

    [notice:]

        when reading an ICNS file with multiple icons in it,

        the first image is returned as such, holding on the other images in its

        imageFrames instvar.

        Thus, the imageEditor will usually present the first of the images,

        and offer a next-in-sequence button to step through them.

        To get a collection of all images, collect the images from the sequence, as in:

            someIcoImage imageFrames collect:#image

    [supported formats:]

    support   format   length                pixels  OS-version  description

    -----------------------------------------------------------------------------   

    r           ICON    128                     32      1.0     32×32 1-bit mono icon

    r           ICN#    256                     32      6.0     32×32 1-bit mono icon with 1-bit mask

                icm#    48                      16      6.0     16×12 1 bit mono icon with 1-bit mask

                icm4    96                      16      7.0     16×12 4 bit icon

                icm8    192                     16      7.0     16×12 8 bit icon

    r           ics#    64 (32 img + 32 mask)   16      6.0     16×16 1-bit mask

    r           ics4    128                     16      7.0     16×16 4-bit icon

    r           ics8    256                     16      7.0     16x16 8 bit icon

                is32    varies (768)            16      8.5     16×16 24-bit icon

    r           s8mk    256                     16      8.5     16x16 8-bit mask

    r           icl4    512                     32      7.0     32×32 4-bit icon

    r           icl8    1,024                   32      7.0     32×32 8-bit icon

    r           il32    varies (3,072)          32      8.5     32x32 24-bit icon

    r           l8mk    1,024                   32      8.5     32×32 8-bit mask

    r           ich#    288                     48      8.5     48×48 1-bit mask

    r           ich4    1,152                   48      8.5     48×48 4-bit icon

    r           ich8    2,304                   48      8.5     48×48 8-bit icon

    r           ih32    varies (6,912)          48      8.5     48×48 24-bit icon

    r           h8mk    2,304                   48      8.5     48×48 8-bit mask

    r           it32    varies (49,152)        128     10.0    128×128 24-bit icon

    r           t8mk    16,384                 128     10.0    128×128 8-bit mask

    r           icp4    varies                  16     10.7    16x16 icon in JPEG 2000 or PNG format

    r           icp5    varies                  32     10.7    32x32 icon in JPEG 2000 or PNG format

                icp6    varies                  64     10.7    64x64 icon in JPEG 2000 or PNG format

    r           ic07    varies                 128     10.7    128x128 icon in JPEG 2000 or PNG format

    r           ic08    varies                 256     10.5    256×256 icon in JPEG 2000 or PNG format

    r           ic09    varies                 512     10.5    512×512 icon in JPEG 2000 or PNG format

    r           ic10    varies                1024     10.7    1024×1024 in 10.7 (or 512x512@2x 'retina' in 10.8) icon in JPEG 2000 or PNG format

                ic11    varies                  32     10.8    16x16@2x 'retina' icon in JPEG 2000 or PNG format

                ic12    varies                  64     10.8    32x32@2x 'retina' icon in JPEG 2000 or PNG format

                ic13    varies                 256     10.8    128x128@2x 'retina' icon in JPEG 2000 or PNG format

                ic14    varies                 512     10.8    256x256@2x 'retina' icon in JPEG 2000 or PNG format

     Other types (ignored):

               'TOC '   varies          'Table of Contents' 

                                        a list of all image types in the file, 

                                        and their sizes (added in Mac OS X 10.7)

                'icnV'  4               4-byte big endian float 

                                        - equal to the bundle version number of Icon Composer.app that created to icon

    [See also:]

        Image Form Icon

        GIFReader JPEGReader PNGReader TIFFReader WindowsIconReader

        http://en.wikipedia.org/wiki/Apple_Icon_Image_format

"

! !

!MacOSXIconReader class methodsFor:'initialization'!

initialize

    "install myself in the Image classes fileFormat table

     for the `.icns' extension."

    "/ MIMETypes defineImageType:'image/x-icns' suffix:'icns'  reader:self.

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

! !

!MacOSXIconReader class methodsFor:'testing'!

canRepresent:anImage

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

     Assuming that we store in PNG format, delegate that decision."

    ^ PNGReader canRepresent:anImage

!

isValidImageFile:aFileName

    "return true, if aFileName is an apple osx icon file"

    |id inStream|

    inStream := self streamReadingFile:aFileName.

    inStream isNil ifTrue:[^ false].

    inStream text.

    id := String new:4.

    inStream nextBytes:4 into:id.

    inStream close.

    ^ (id = 'icns')

! !

!MacOSXIconReader methodsFor:'image reading'!

fromStream:aStream

    "read a stream containing an icon image (or a collection of images).

     Leave image description in instance variables."

    |sizeRemaining id img firstImage frame imageCount chunkType numChunkBytes chunkData|

    inStream := aStream.

    aStream text.

    "icon-files are always msb"

    byteOrder := #msb.

    id := aStream nextBytes:4.

    id size ~~ 4 ifTrue:[

        ^ self fileFormatError:'not an icns file (short read)'.

    ].

    id := id asString.

    sizeRemaining := aStream nextUnsignedInt32MSB:true.

    sizeRemaining := sizeRemaining - 4 - 4. "/ file magic and size are included in count

    (id ~= 'icns') ifTrue:[

        chunkData := aStream next:sizeRemaining.

        image := self readSingleIcon:chunkType from:chunkData.

        ^ self

    ].

    imageCount := 0.

    [ sizeRemaining > 0 ] whileTrue:[

        chunkType := aStream next:4.

        chunkType size ~~ 4 ifTrue:[

            ^ self fileFormatError:'not an icns file (short read on icon type)'.

        ].

        chunkType := chunkType asString.

        numChunkBytes := aStream nextUnsignedInt32MSB:true.

        numChunkBytes := numChunkBytes - 4 - 4. "/ type and size are included in count

        chunkData := aStream nextBytes:numChunkBytes.

        sizeRemaining := sizeRemaining - 4 - 4 - numChunkBytes.

        img := self readSingleIcon:chunkType from:chunkData.

        "/ unsupported images are skipped...

        img notNil ifTrue:[

            imageCount == 0 ifTrue:[

                firstImage := image := img.

            ] ifFalse:[

                imageCount == 1 ifTrue:[

                    imageSequence := ImageSequence new.

                    img imageSequence:imageSequence.

                    "/ add frame for first image.

                    frame := ImageFrame new image:firstImage.

                    imageSequence add:frame.

                ].  

                "/ add frame for this image.

                frame := ImageFrame new image:img.

                imageSequence add:frame.

            ].

            imageCount := imageCount + 1.

        ].

    ].

    self breakPoint:#cg.

    "

     Image fromFile:'/Applications/TextEdit.app/Contents/Resources/txt.icns'

    "

    "Modified: / 22-02-2017 / 10:24:38 / cg"

!

readSingleIcon:iconType from:iconBytes

    "read a single image from the inputStream."

    Logger info:'ICNSReader: read %1' with:iconType.

    ^ Error handle:[:ex |

        self fileFormatError:'internal error while reading: ',iconType.

        nil

    ] do:[

        |img|

        img := self 

            perform:('read_',(iconType copyReplaceAny:#( $# $ ) with:$_),'_from:') asSymbol 

            with:iconBytes

            ifNotUnderstood:[

                self breakPoint:#cg.

                ('MacOSXIconReader: unsupported icon format: ',iconType) infoPrintCR.

                self fileFormatError:'unsupported icon format: ',iconType.

                nil

            ].

        "/ img inspect.    

        img    

    ].

    "

     self fromFile:'/Applications/TextEdit.app/Contents/Resources/txt.icns'

     self fromFile:'test.icns'

    "

    "Modified: / 08-02-2017 / 19:08:05 / stefan"

    "Modified: / 22-02-2017 / 12:11:30 / cg"

! !

!MacOSXIconReader methodsFor:'image writing'!

save:anImage onStream:aStream

    "save an icon to aStream."

    self saveAll:(Array with:anImage) onStream:aStream.

    "

     self 

        save:(Image fromScreen:(0@0 corner:16@16))

        onFile:'test.icns'

    "

!

saveAll:aCollectionOfImages onStream:aStream

    "save a number of images to aStream."

    |tempStream|

    (aCollectionOfImages conform:

        [:eachImage |

            (eachImage width = eachImage height)

            and:[ (#(16 32 64 128 256 512 1024) includes:eachImage width)]

        ]

    ) ifFalse:[

        ^ self fileFormatError:'unsupported image size (must be square and width 16, 32, 64, 128, 512 or 1024)'.

    ].

    tempStream := ReadWriteStream on:(ByteArray new:1024).

    aCollectionOfImages do:[:eachImage |

        |typeCode s data|

        s := WriteStream on:(ByteArray new:1024).

        PNGReader save:eachImage onStream:s.

        data := s contents.

        self assert:data notEmptyOrNil.

        typeCode := #(16 32 64 128 256 512 1024) 

                    map: #('ipc4' 'ipc5' 'ipc6' 'ic07' 'ic08' 'ic09' 'ic10')

                    at:eachImage width ifAbsent:[self error]. 

        tempStream

            nextPutBytes:typeCode;

            nextPutInt32:(data size + 4 + 4) MSB:true;

            nextPutAll:data.

    ].

    aStream 

        binary;

        nextPutBytes:'icns';

        nextPutInt32:(tempStream position + 4 + 4) MSB:true;

        nextPutAll:(tempStream contents).

    "

     self 

        save:(Image fromScreen:(0@0 corner:16@16))

        onFile:'test.icns'.

     'test.icns' asFilename exists.

     Image fromFile:'test.icns'

     ImageSequence

     MacOSXIconReader

         saveAll:{

                    (Image fromScreen:(0@0 corner:16@16)) .

                    (Image fromScreen:(0@0 corner:32@32)) .

                    (Image fromScreen:(0@0 corner:64@64)) .

                    (Image fromScreen:(0@0 corner:128@128)) .

                 }

         onFile:'test.icns'   

    "

    "Modified: / 22-02-2017 / 12:16:07 / cg"

! !

!MacOSXIconReader methodsFor:'private'!

colormap4

    ^ #[

           16rFF 16rFF 16rFF

           16rFC 16rF3 16r05

           16rFF 16r64 16r02

           16rDD 16r08 16r06

           16rF2 16r08 16r84

           16r46 16r00 16rA5

           16r00 16r00 16rD4

           16r02 16rAB 16rEA

           16r1F 16rB7 16r14

           16r00 16r64 16r11

           16r56 16r2C 16r05

           16r90 16r71 16r3A

           16rC0 16rC0 16rC0

           16r80 16r80 16r80

           16r40 16r40 16r40

           16r00 16r00 16r00

    ]

!

colormap8

    ^ #[

           16rFF 16rFF 16rFF

           16rFF 16rFF 16rCC

           16rFF 16rFF 16r99

           16rFF 16rFF 16r66

           16rFF 16rFF 16r33

           16rFF 16rFF 16r00

           16rFF 16rCC 16rFF

           16rFF 16rCC 16rCC

           16rFF 16rCC 16r99

           16rFF 16rCC 16r66

           16rFF 16rCC 16r33

           16rFF 16rCC 16r00

           16rFF 16r99 16rFF

           16rFF 16r99 16rCC

           16rFF 16r99 16r99

           16rFF 16r99 16r66

           16rFF 16r99 16r33

           16rFF 16r99 16r00

           16rFF 16r66 16rFF

           16rFF 16r66 16rCC

           16rFF 16r66 16r99

           16rFF 16r66 16r66

           16rFF 16r66 16r33

           16rFF 16r66 16r00

           16rFF 16r33 16rFF

           16rFF 16r33 16rCC

           16rFF 16r33 16r99

           16rFF 16r33 16r66

           16rFF 16r33 16r33

           16rFF 16r33 16r00

           16rFF 16r00 16rFF

           16rFF 16r00 16rCC

           16rFF 16r00 16r99

           16rFF 16r00 16r66

           16rFF 16r00 16r33

           16rFF 16r00 16r00

           16rCC 16rFF 16rFF

           16rCC 16rFF 16rCC

           16rCC 16rFF 16r99

           16rCC 16rFF 16r66

           16rCC 16rFF 16r33

           16rCC 16rFF 16r00

           16rCC 16rCC 16rFF

           16rCC 16rCC 16rCC

           16rCC 16rCC 16r99

           16rCC 16rCC 16r66

           16rCC 16rCC 16r33

           16rCC 16rCC 16r00

           16rCC 16r99 16rFF

           16rCC 16r99 16rCC

           16rCC 16r99 16r99

           16rCC 16r99 16r66

           16rCC 16r99 16r33

           16rCC 16r99 16r00

           16rCC 16r66 16rFF

           16rCC 16r66 16rCC

           16rCC 16r66 16r99

           16rCC 16r66 16r66

           16rCC 16r66 16r33

           16rCC 16r66 16r00

           16rCC 16r33 16rFF

           16rCC 16r33 16rCC

           16rCC 16r33 16r99

           16rCC 16r33 16r66

           16rCC 16r33 16r33

           16rCC 16r33 16r00

           16rCC 16r00 16rFF

           16rCC 16r00 16rCC

           16rCC 16r00 16r99

           16rCC 16r00 16r66

           16rCC 16r00 16r33

           16rCC 16r00 16r00

           16r99 16rFF 16rFF

           16r99 16rFF 16rCC

           16r99 16rFF 16r99

           16r99 16rFF 16r66

           16r99 16rFF 16r33

           16r99 16rFF 16r00

           16r99 16rCC 16rFF

           16r99 16rCC 16rCC

           16r99 16rCC 16r99

           16r99 16rCC 16r66

           16r99 16rCC 16r33

           16r99 16rCC 16r00

           16r99 16r99 16rFF

           16r99 16r99 16rCC

           16r99 16r99 16r99

           16r99 16r99 16r66

           16r99 16r99 16r33

           16r99 16r99 16r00

           16r99 16r66 16rFF

           16r99 16r66 16rCC

           16r99 16r66 16r99

           16r99 16r66 16r66

           16r99 16r66 16r33

           16r99 16r66 16r00

           16r99 16r33 16rFF

           16r99 16r33 16rCC

           16r99 16r33 16r99

           16r99 16r33 16r66

           16r99 16r33 16r33

           16r99 16r33 16r00

           16r99 16r00 16rFF

           16r99 16r00 16rCC

           16r99 16r00 16r99

           16r99 16r00 16r66

           16r99 16r00 16r33

           16r99 16r00 16r00

           16r66 16rFF 16rFF

           16r66 16rFF 16rCC

           16r66 16rFF 16r99

           16r66 16rFF 16r66

           16r66 16rFF 16r33

           16r66 16rFF 16r00

           16r66 16rCC 16rFF

           16r66 16rCC 16rCC

           16r66 16rCC 16r99

           16r66 16rCC 16r66

           16r66 16rCC 16r33

           16r66 16rCC 16r00

           16r66 16r99 16rFF

           16r66 16r99 16rCC

           16r66 16r99 16r99

           16r66 16r99 16r66

           16r66 16r99 16r33

           16r66 16r99 16r00

           16r66 16r66 16rFF

           16r66 16r66 16rCC

           16r66 16r66 16r99

           16r66 16r66 16r66

           16r66 16r66 16r33

           16r66 16r66 16r00

           16r66 16r33 16rFF

           16r66 16r33 16rCC

           16r66 16r33 16r99

           16r66 16r33 16r66

           16r66 16r33 16r33

           16r66 16r33 16r00

           16r66 16r00 16rFF

           16r66 16r00 16rCC

           16r66 16r00 16r99

           16r66 16r00 16r66

           16r66 16r00 16r33

           16r66 16r00 16r00