"

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

"

ImageReader subclass:#PBMReader

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	category:'Graphics-Images-Support'

!

!PBMReader class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1992 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 and saving Portable BitMap-file 

    images (Jef Poskanzers portable bitmap package).

    Reading is supported for 1bit (pbm), greyscale (pgm) and 24bit (ppm) formats.

    (i.e. P1, P3, P4, P5, P6 and P7 formats)

    Writing is (currently) only supported for the binary formats;

    i.e. 1-bit images as (pbm P4), 8-bit gray as (pgm P5) and 24-bit images as (pnm P6).

    Q: should we broil this one to perfection and base all others on

       pipe-readers to the various pbmplus converters ?

    [See also:]

        Image Form Icon

        BlitImageReader FaceReader GIFReader JPEGReader PCXReader 

        ST80FormReader SunRasterReader TargaReader TIFFReader WindowsIconReader 

        XBMReader XPMReader XWDReader 

"

! !

!PBMReader class methodsFor:'initialization'!

initialize

    "install myself in the Image classes fileFormat table

     for the `.pbm', '.pgm' and '.pnm' extensions."

    MIMETypes defineImageType:'image/x-portable-bitmap'  suffix:'pbm' reader:self.

    MIMETypes defineImageType:'image/x-portable-graymap' suffix:'pgm' reader:self.

    MIMETypes defineImageType:'image/x-portable-anymap'  suffix:'pnm' reader:self.

    MIMETypes defineImageType:'image/x-portable-pixmap'  suffix:'ppm' reader:self.

    "Modified: / 1.2.1997 / 15:02:14 / cg"

    "Created: / 3.2.1998 / 17:19:59 / cg"

! !

!PBMReader class methodsFor:'testing'!

canRepresent:anImage

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

     Currently, only 1bit B&W, 8bit-grey and 24bit RGB images are supported."

    |depth photometric|

    anImage photometric == #rgb ifTrue:[

        ^ depth==24

    ].

    (depth := anImage depth) == 1 ifTrue:[^ true].

    depth == 8 ifTrue:[

        photometric := anImage photometric.

        ^ (photometric == #blackIs0) or:[photometric == #whiteIs0]

    ].

    ^ false

    "Modified: 17.10.1997 / 20:20:52 / cg"

!

isValidImageFile:aFileName

    "return true, if aFileName contains a PBM image (which I can read)"

    |inStream pnmType ok|

    inStream := self streamReadingFile:aFileName.

    inStream isNil ifTrue:[^ false].

    inStream text.

    ok := inStream next == $P.

    ok ifTrue:[

        pnmType := inStream next.

        ok := #( $1 $3 $4 $5 $6 $7) includes:pnmType.

    ].

    inStream close. 

    ^ ok

    "Modified: / 7.12.1998 / 14:27:11 / cg"

! !

!PBMReader methodsFor:'private'!

skipPBMJunkOn:aStream 

    "this method removes any superfluous characters from the input stream."

    | char foundNL|

    [

        char := aStream peek.

        [char == $#] whileTrue:[

            "Start of a comment. Skip to end-of-line."

"/            foundNL := (aStream skipUpTo: Character cr) notNil.

            foundNL := (aStream skipThrough: Character cr) notNil.

            foundNL ifFalse: [

                "Must be EOF"

                ^self

            ].

            char := aStream peek

        ].

        aStream atEnd not and: [char isSeparator]

    ] whileTrue: [aStream next]

    "Created: / 3.2.1998 / 17:20:37 / cg"

    "Modified: / 7.9.1998 / 15:49:07 / cg"

!

skipXPMJunkOn:aStream

    "this method removes any superfluous characters from the input stream."

    | char |

    [       

        char := aStream peek. 

        aStream atEnd not and: [char isSeparator not]

    ] whileTrue: [aStream next].

    [aStream atEnd not and: [char isSeparator]] whileTrue: [

        aStream next. char := aStream peek

    ].

    aStream atEnd ifTrue: [^char].

    (char isDigit) ifTrue: [ ^char ].

    (char == $") ifTrue: [ 

        aStream next. 

        char := aStream peek. 

        (char isLetterOrDigit 

         or: [(char == $#) 

         or: [char == Character space]]) ifFalse:[

            ^ self skipXPMJunkOn: aStream 

        ] ifTrue: [^char]

    ].

    ^self skipXPMJunkOn: aStream.

    "Created: / 3.2.1998 / 17:20:54 / cg"

! !

!PBMReader methodsFor:'reading from file'!

fromStream:aStream

    "read a Portable bitmap file format as of Jeff Poskanzers Portable Bitmap Package.

     supported are PBM, PGB and PNM files." 

    | pnmType |

    inStream := aStream.

    inStream text.

    inStream next == $P ifFalse:[

        ^ self fileFormatError:'not PNM format'.

    ].

    pnmType := inStream next.

    (pnmType == $1) ifTrue: [

        ^ self readDepth1AsciiPBMStream:aStream

    ].

    (pnmType == $3) ifTrue: [

        ^ self readDepth24AsciiPBMStream:aStream

    ].

    (pnmType == $4) ifTrue: [

        ^ self readDepth1PBMStream:aStream

    ].

    (pnmType == $5) ifTrue: [

        ^ self readDepth8PGMStream:aStream

    ].

    (pnmType == $6) ifTrue: [

        ^ self readDepth24PPMStream:aStream

    ].

    (pnmType == $7) ifTrue: [

        ^ self readDepth8PPMStream:aStream

    ].

    ^ self fileFormatError:'No recognized PNM file format'.

    "

     PBMReader fromFile:'bitmaps/testimg.ppm'

     PBMReader fromFile:'../../fileIn/bitmaps/keyboard.pbm'

     PBMReader fromFile:'/home2/cg/ppm2fli_b1-92/jeff.001'

    "

    "Created: / 3.2.1998 / 17:25:34 / cg"

    "Modified: / 7.9.1998 / 15:44:29 / cg"

!

readDepth1AsciiPBMStream:aStream 

    "import portable bitmap ascii (PBM, P1 format); P1 is already read"

    |n bits rowIdx dstIdx bytesPerRow char|

    self skipPBMJunkOn:aStream.

    width := Integer readFrom:aStream.

    width > 0 ifFalse: [

        ^ self fileFormatError:'Invalid width'.

    ].

    self skipPBMJunkOn:aStream.

    height := Integer readFrom:aStream.

    height > 0 ifFalse: [

        ^ self fileFormatError:'Invalid height'.

    ].

    aStream nextLine "skipThrough: Character cr".

    bytesPerRow := (width + 7) // 8.

    data := ByteArray new:bytesPerRow * height.

    rowIdx := 1.

    1 to:height do:[:row |

        dstIdx := rowIdx.

        bits := 0. n := 0.

        1 to:width do:[:col |

            char := aStream next.

            [char notNil and:[char isSeparator]] whileTrue:[

                char := aStream next

            ].

            bits := bits bitShift:1.

            char == $1 ifTrue:[

                bits := bits bitOr:1

            ].

            n := n + 1.

            n == 8 ifTrue:[

                data at:dstIdx put:bits.

                dstIdx := dstIdx + 1.

                bits := 0.

                n := 0.

            ].

        ].

        n ~~ 0 ifTrue:[

            data at:dstIdx put:bits.

        ].

        rowIdx := rowIdx + bytesPerRow

    ].

    photometric := #whiteIs0.

    samplesPerPixel := 1.

    bitsPerSample := #(1).

    "Created: / 3.2.1998 / 17:21:22 / cg"

    "Modified: / 3.2.1998 / 17:56:32 / cg"

!

readDepth1PBMStream:aStream 

    "import portable bitmap (PBM, P4 format); P4 is already read"

    |bytesPerRow|

    self skipPBMJunkOn:aStream.

    width := Integer readFrom:aStream onError:0.

    width > 0 ifFalse: [

        ^ self fileFormatError:'Invalid width'.

    ].

    self skipPBMJunkOn:aStream.

    height := Integer readFrom:aStream onError:0.

    height > 0 ifFalse: [

        ^ self fileFormatError:'Invalid height'.

    ].

    aStream nextLine "skipThrough: Character cr".

    bytesPerRow := width // 8.

    ((width \\ 8) ~~ 0) ifTrue:[

        bytesPerRow := bytesPerRow + 1

    ].

    "/ the rest is the binary image data ...

    aStream binary.

    data := ByteArray uninitializedNew:(bytesPerRow*height).

    aStream nextBytes:(data size) into:data.

    photometric := #blackIs0.

    samplesPerPixel := 1.

    bitsPerSample := #(1).

    "Created: / 3.2.1998 / 17:21:37 / cg"

    "Modified: / 3.2.1998 / 17:56:59 / cg"

!

readDepth24AsciiPBMStream:aStream

    "import ascii portable pixmap (PBM, P3 format); P3 is already read"

    |maxval 

     nBytes "{Class: SmallInteger }" 

     v      "{Class: SmallInteger }"

     c|

    self skipPBMJunkOn:aStream.

    width := Integer readFrom:aStream.

    width > 0 ifFalse: [

        ^ self fileFormatError:'Invalid width'.

    ].

    self skipPBMJunkOn:aStream.

    height := Integer readFrom:aStream.

    height > 0 ifFalse: [

        ^ self fileFormatError:'Invalid height'.

    ].

    self skipPBMJunkOn:aStream.

    maxval := Integer readFrom:aStream.

    maxval >= 256 ifTrue: [

        ^ self fileFormatError:'Invalid format'.

    ].

    aStream skipThrough: Character cr.

    nBytes := width*height*3.

    data := ByteArray new:nBytes.

    1 to:nBytes do:[:i |

        aStream skipSeparators.

        v := 0.

        c := aStream next.

        [c isDigit] whileTrue:[

            v := v * 10 + (c digitValue).

            c := aStream next.

        ].

        data at:i put:v

    ].

    photometric := #rgb.

    samplesPerPixel := 3.

    bitsPerSample := #(8 8 8).

    "Created: / 3.2.1998 / 17:21:55 / cg"

    "Modified: / 3.2.1998 / 17:57:30 / cg"

!

readDepth24PPMStream:aStream

    "import portable pixmap (PPM, P6 format); P6 is already read"

    | maxval |

    self skipPBMJunkOn:aStream.

    width := Integer readFrom:aStream.

    width > 0 ifFalse: [

        ^ self fileFormatError:'Invalid width'.

    ].

    self skipPBMJunkOn:aStream.

    height := Integer readFrom:aStream.

    height > 0 ifFalse: [

        ^ self fileFormatError:'Invalid height'.

    ].

    self skipPBMJunkOn:aStream.

    maxval := Integer readFrom:aStream.

    maxval >= 256 ifTrue: [

        ^ self fileFormatError:'Invalid format'.

    ].

    aStream skipThrough: Character cr.

    "/ the rest is the binary image data ...

    aStream binary.

    data := ByteArray uninitializedNew:(width*height*3).

    aStream nextBytes:(data size) into:data.

    photometric := #rgb.

    samplesPerPixel := 3.

    bitsPerSample := #(8 8 8).

    "Created: / 3.2.1998 / 17:22:18 / cg"

    "Modified: / 3.2.1998 / 17:57:26 / cg"

!

readDepth8PGMStream:aStream 

    "import portable gray map (PGM, P5 format); P5 is already read"

    |maxval|

    self skipPBMJunkOn:aStream.

    width := Integer readFrom:aStream.

    width > 0 ifFalse:[ 

        ^ self fileFormatError:'Invalid width'.

    ].

    self skipPBMJunkOn:aStream.

    height := Integer readFrom:aStream.

    height > 0 ifFalse:[ 

        ^ self fileFormatError:'Invalid height'.

    ].

    self skipPBMJunkOn:aStream.

    maxval := Integer readFrom:aStream.

    maxval >= 256 ifTrue:[

        ^ self fileFormatError:'Invalid format'.

    ].

    aStream nextLine "skipThrough: Character cr".

    "/ the rest is the binary image data ...

    aStream binary.

    data := ByteArray uninitializedNew:(width*height).

    aStream nextBytes:(data size) into:data.

    photometric := #blackIs0.

    samplesPerPixel := 1.

    bitsPerSample := #(8).

    "Modified: / 3.2.1998 / 17:57:21 / cg"

!

readDepth8PPMStream:aStream

    "import portable pixmap (PPM, P7 format); P7 is already read"

    | maxval bitsRed bitsGreen bitsBlue|

    aStream skipSeparators.

    bitsRed := aStream next - $0.

    bitsGreen := aStream next - $0.

    bitsBlue := aStream next - $0.

    self skipPBMJunkOn:aStream.

    width := Integer readFrom:aStream.

    width > 0 ifFalse: [

        ^ self fileFormatError:'Invalid width'.

    ].

    self skipPBMJunkOn:aStream.

    height := Integer readFrom:aStream.

    height > 0 ifFalse: [

        ^ self fileFormatError:'Invalid height'.

    ].

    self skipPBMJunkOn:aStream.

    maxval := Integer readFrom:aStream.

    maxval >= 256 ifTrue: [

        ^ self fileFormatError:'Invalid format'.

    ].

    aStream skipThrough: Character cr.

    "/ the rest is the binary image data ...

    aStream binary.

    data := ByteArray uninitializedNew:(width*height*1).

    aStream nextBytes:(data size) into:data.

    photometric := #rgb.

    samplesPerPixel := 3.

    bitsPerSample := (Array with:bitsRed with:bitsGreen with:bitsBlue).

    "Created: / 7.9.1998 / 15:44:05 / cg"

    "Modified: / 7.9.1998 / 15:50:36 / cg"

! !

!PBMReader methodsFor:'writing to file'!

save:image onFile:aFileName

    "save image as PBM/PGM/PNM file on aFileName"

    |bitsPerPixel|

    image mask notNil ifTrue:[

        Image informationLostQuerySignal

            raiseWith:image

            errorString:('PBM format does not support an imageMask').

    ].

    outStream := FileStream newFileNamed:aFileName.

    outStream isNil ifTrue:[