Codec.PNM

PNM image format header parsing and pretty printing.

PNM is PBM + PGM + PPM, a family of lowest common denominator image file formats.

References: http://netpbm.sourceforge.net/doc/pnm.html.

Documentation

data PNM

PNM image headers.

Constructors

PBM

Fields

pnmPlain :: Bool

pnmWidth :: Integer

pnmHeight :: Integer

PGM

Fields

pnmPlain :: Bool

pnmWidth :: Integer

pnmHeight :: Integer

pnmMaxVal :: Integer

PPM

Fields

pnmPlain :: Bool

pnmWidth :: Integer

pnmHeight :: Integer

pnmMaxVal :: Integer

Instances

Eq PNM

Ord PNM

Show PNM

pnmRasterBytes :: PNM -> Maybe Integer

Compute the raster size in bytes for binary PNM images.

pnmPretty :: PNM -> ByteString

Pretty-print a PNM image header without any comments.

data Parse p

The result of parsing.

Constructors

Wrong

Fields

parseMalformed :: ByteString

Empty

Parse

Fields

parseResult :: p

parseRawResult :: ByteString

parseRemainder :: ByteString

Instances

Eq p => Eq (Parse p)

Ord p => Ord (Parse p)

Show p => Show (Parse p)

pnmParse :: ByteString -> Parse PNM

Parse a PNM image header.

pnms :: ByteString -> [(PNM, ByteString)]

Parse a sequence of binary PNM images.

Malformed input (including huge raster sizes or plain images) is treated as end-of-image-stream.

unpnms :: [(PNM, ByteString)] -> ByteString

Pretty-print a sequence of binary PNM images.

The precondition that the raster is of the correct length is not checked, so malformed output is possible.

onPNMs :: (PNM -> ByteString -> (PNM, ByteString)) -> ByteString -> ByteString

Process a sequence of binary PNM images.

Malformed input (including huge raster sizes or plain images) is treated as end-of-image-stream.

The precondition that the raster is of the correct length is not checked, so malformed output is possible.

Header comments are not preserved.

onPNMs' :: (PNM -> ByteString -> ByteString) -> ByteString -> ByteString

Process a sequence of binary PNM images.

Malformed input (including huge raster sizes or plain images) is treated as end-of-image-stream.

The precondition that the raster is of the correct length is not checked, so malformed output is possible.

Header comments are preserved. Assuming well-formed input:

 onPNMs' (\_ r -> r) = id