The png-read Reference Manual

Table of Contents

The png-read Reference Manual

This is the png-read Reference Manual, version 0.3.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:58:41 2020 GMT+0.

1 Introduction

Portable Network Graphics (PNG) decoder (more or less) for Common Lisp.

All critical chunks are implemented.  Most ancillary chunks  are. It should be able to read back any
file produced by ZPNG. Interlaced files can be read, but without progressive loading.

Usage: read-png-file (file)  and read-png-datastream (stream), both return a  png-state object and a
boolean to  indicate if CRC  was successful,  which most interesting  property is image-data,  a two
(grayscale) or  three dimensional array containing  image data. Other properties  are width, height,
bit-depth and  colour-type. If file was loaded by read-png-file slot png-file contains pathname used.

Dynamic variable *crc-fail-behaviour* can  be set to one of :error, :warn  or :no-action (default is :error),  and   controls  what   happens  on   checksum  failure.   Error   signalled  is   of  type png-read:crc-failure, and restart png-read:ignore-crc-failure is established.

For indexed  images slot index-data  contains an  array with indices  in palette (stored  in palette
slot), and image-data contains decoded colors.

The library  loads all files from  http://www.schaik.com/pngsuite/ , but  I did not check  whether it
does so correctly.

Note that ancillary chunks are mostly untested. They never modify primary image data array directly,
but provide additional  information in slots of png-state object. Of  the ancillary chunks specified
in http://www.w3.org/TR/2003/REC-PNG-20031110/  missing are: cHRM,  iCCP and sPLT. gAMA  is present,
but using it is responsibility of library user.

Dynamic variable *warn-missing-ancillaries* controls whether library warns on encountering unknown
ancillary chunk.

Ancillary chunks: 
  tRNS - if present, additional alpha map is stored in slot transparency 
  gAMA - if  present, image gamma is stored in slot gamma 
  sBIT - if present, the original number of significant bits is stored 
         in slot significant-bits as a property list
  sRGB - if present, rendering intent is storen in slot rendering-intent as a keyword symbol
  tEXt - if present, text strings are collected in slot textual-data as an association list of keyword 
         and string
  zTXt - if present, text strings are collected in slot textual-data as an association list of keyword 
         and string
  iTXt - if present, text strings are collected in slot texttual-data as an association list of keyword 
         and a list of language tag, translated keyword and translated text
  bKGD - if present, preferred background is stored in slot preferred-background as an array of color 
         components (RGB), greyscale datum or palette index
  hIST - if present, image histogram is stored in slot image-histogram as an array
  pHYS - if present, intended pixel size is stored in slot physical-dimensions as a property list
  tIME - if present, last modification time is stored in slot last-modification as an universal time

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 png-read

Author

Jakub Higersberger <ramarren@gmail.com>

License

BSD-style

Description

A library for reading PNG files.

Version

0.3.1

Dependencies

• iterate
• chipz
• babel

Source

png-read.asd (file)

Components

• package.lisp (file)
• png-state.lisp (file)
• deinterlace.lisp (file)
• util.lisp (file)
• decode.lisp (file)
• crc.lisp (file)
• critical-chunks.lisp (file)
• ancillary-chunks.lisp (file)
• basic-chunks.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 png-read.asd

Location

png-read.asd

Systems

png-read (system)

3.1.2 png-read/package.lisp

Parent

png-read (system)

Location

package.lisp

Packages

png-read

3.1.3 png-read/png-state.lisp

Dependency

package.lisp (file)

Parent

png-read (system)

Location

png-state.lisp

Exported Definitions

• bit-depth (method)
• (setf bit-depth) (method)
• colour-type (method)
• (setf colour-type) (method)
• gamma (method)
• (setf gamma) (method)
• height (method)
• (setf height) (method)
• image-data (method)
• (setf image-data) (method)
• image-histogram (method)
• (setf image-histogram) (method)
• last-modification (method)
• (setf last-modification) (method)
• palette (method)
• (setf palette) (method)
• physical-dimensions (method)
• (setf physical-dimensions) (method)
• png-state (class)
• preferred-background (method)
• (setf preferred-background) (method)
• rendering-intent (method)
• (setf rendering-intent) (method)
• significant-bits (method)
• (setf significant-bits) (method)
• textual-data (method)
• (setf textual-data) (method)
• transparency (method)
• (setf transparency) (method)
• width (method)
• (setf width) (method)

Internal Definitions

• *png-state* (special variable)
• compression (method)
• (setf compression) (method)
• datastream (method)
• (setf datastream) (method)
• filter-method (method)
• (setf filter-method) (method)
• finished (method)
• (setf finished) (method)
• index-data (method)
• (setf index-data) (method)
• interlace-method (method)
• (setf interlace-method) (method)
• png-file (method)
• (setf png-file) (method)
• postprocess-ancillaries (method)
• (setf postprocess-ancillaries) (method)

3.1.4 png-read/deinterlace.lisp

Dependencies

• package.lisp (file)
• png-state.lisp (file)

Parent

png-read (system)

Location

deinterlace.lisp

Internal Definitions

• *adam7* (special variable)
• decode-interlaced (function)
• decode-subimages (function)
• finish-deinterlace (function)
• get-height-passlist (function)
• make-deinterlace-arrays (function)
• split-datastream (function)

3.1.5 png-read/util.lisp

Dependency

package.lisp (file)

Parent

png-read (system)

Location

util.lisp

Internal Definitions

• big-endian-vector-to-integer (compiler macro)
• big-endian-vector-to-integer (function)

3.1.6 png-read/decode.lisp

Dependencies

• package.lisp (file)
• util.lisp (file)
• png-state.lisp (file)
• basic-chunks.lisp (file)

Parent

png-read (system)

Location

decode.lisp

Internal Definitions

• decode-data (generic function)
• decode-data (method)
• decode-data (method)
• decode-data (method)
• decode-data (method)
• decode-data (method)
• finish-decoding (function)
• get-scanlines (function)
• paeth-predictor (function)
• set-image-slice-to-index (function)
• sub-byte (function)
• subup-byte (function)
• unfilter-scanlines (function)
• up-byte (function)

3.1.7 png-read/crc.lisp

Dependency

package.lisp (file)

Parent

png-read (system)

Location

crc.lisp

Internal Definitions

• *crc-array* (special variable)
• crc (function)
• finish-crc (function)
• make-crc-array (function)
• start-crc (function)
• updated-crc (function)

3.1.8 png-read/critical-chunks.lisp

Dependencies

• package.lisp (file)
• png-state.lisp (file)
• util.lisp (file)

Parent

png-read (system)

Location

critical-chunks.lisp

Internal Definitions

• parse-critical-chunk (generic function)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• parse-critical-chunk (method)

3.1.9 png-read/ancillary-chunks.lisp

Dependencies

• package.lisp (file)
• png-state.lisp (file)
• util.lisp (file)

Parent

png-read (system)

Location

ancillary-chunks.lisp

Internal Definitions

• *warn-missing-ancillaries* (special variable)
• build-transparency-map (function)
• parse-ancillary-chunk (generic function)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)

3.1.10 png-read/basic-chunks.lisp

Dependencies

• package.lisp (file)
• crc.lisp (file)
• critical-chunks.lisp (file)
• ancillary-chunks.lisp (file)
• png-state.lisp (file)
• util.lisp (file)

Parent

png-read (system)

Location

basic-chunks.lisp

Exported Definitions

• *crc-fail-behaviour* (special variable)
• crc-failure (condition)
• read-png-datastream (function)
• read-png-file (function)

Internal Definitions

• *png-file* (special variable)
• *png-header* (special variable)
• crc-is-of (method)
• crc-read-of (method)
• file-of (method)
• parse-chunk (function)
• read-png-chunks (function)

4 Packages

Packages are listed by definition order.

4.1 png-read

Source

package.lisp (file)

Use List

• babel
• chipz
• iterate
• common-lisp

Exported Definitions

• *crc-fail-behaviour* (special variable)
• bit-depth (generic function)
• bit-depth (method)
• (setf bit-depth) (method)
• (setf bit-depth) (generic function)
• colour-type (generic function)
• colour-type (method)
• (setf colour-type) (method)
• (setf colour-type) (generic function)
• crc-failure (condition)
• gamma (generic function)
• gamma (method)
• (setf gamma) (method)
• (setf gamma) (generic function)
• height (generic function)
• height (method)
• (setf height) (method)
• (setf height) (generic function)
• image-data (generic function)
• image-data (method)
• (setf image-data) (method)
• (setf image-data) (generic function)
• image-histogram (generic function)
• image-histogram (method)
• (setf image-histogram) (method)
• (setf image-histogram) (generic function)
• last-modification (generic function)
• last-modification (method)
• (setf last-modification) (method)
• (setf last-modification) (generic function)
• palette (generic function)
• palette (method)
• (setf palette) (method)
• (setf palette) (generic function)
• physical-dimensions (generic function)
• physical-dimensions (method)
• (setf physical-dimensions) (method)
• (setf physical-dimensions) (generic function)
• png-state (class)
• preferred-background (generic function)
• preferred-background (method)
• (setf preferred-background) (method)
• (setf preferred-background) (generic function)
• read-png-datastream (function)
• read-png-file (function)
• rendering-intent (generic function)
• rendering-intent (method)
• (setf rendering-intent) (method)
• (setf rendering-intent) (generic function)
• significant-bits (generic function)
• significant-bits (method)
• (setf significant-bits) (method)
• (setf significant-bits) (generic function)
• textual-data (generic function)
• textual-data (method)
• (setf textual-data) (method)
• (setf textual-data) (generic function)
• transparency (generic function)
• transparency (method)
• (setf transparency) (method)
• (setf transparency) (generic function)
• width (generic function)
• width (method)
• (setf width) (method)
• (setf width) (generic function)

Internal Definitions

• *adam7* (special variable)
• *crc-array* (special variable)
• *png-file* (special variable)
• *png-header* (special variable)
• *png-state* (special variable)
• *warn-missing-ancillaries* (special variable)
• big-endian-vector-to-integer (compiler macro)
• big-endian-vector-to-integer (function)
• build-transparency-map (function)
• compression (generic function)
• compression (method)
• (setf compression) (method)
• (setf compression) (generic function)
• crc (function)
• crc-is-of (generic function)
• crc-is-of (method)
• crc-read-of (generic function)
• crc-read-of (method)
• datastream (generic function)
• datastream (method)
• (setf datastream) (method)
• (setf datastream) (generic function)
• decode-data (generic function)
• decode-data (method)
• decode-data (method)
• decode-data (method)
• decode-data (method)
• decode-data (method)
• decode-interlaced (function)
• decode-subimages (function)
• file-of (generic function)
• file-of (method)
• filter-method (generic function)
• filter-method (method)
• (setf filter-method) (method)
• (setf filter-method) (generic function)
• finish-crc (function)
• finish-decoding (function)
• finish-deinterlace (function)
• finished (generic function)
• finished (method)
• (setf finished) (method)
• (setf finished) (generic function)
• get-height-passlist (function)
• get-scanlines (function)
• index-data (generic function)
• index-data (method)
• (setf index-data) (method)
• (setf index-data) (generic function)
• interlace-method (generic function)
• interlace-method (method)
• (setf interlace-method) (method)
• (setf interlace-method) (generic function)
• make-crc-array (function)
• make-deinterlace-arrays (function)
• paeth-predictor (function)
• parse-ancillary-chunk (generic function)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-ancillary-chunk (method)
• parse-chunk (function)
• parse-critical-chunk (generic function)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• parse-critical-chunk (method)
• png-file (generic function)
• png-file (method)
• (setf png-file) (method)
• (setf png-file) (generic function)
• postprocess-ancillaries (generic function)
• postprocess-ancillaries (method)
• (setf postprocess-ancillaries) (method)
• (setf postprocess-ancillaries) (generic function)
• read-png-chunks (function)
• set-image-slice-to-index (function)
• split-datastream (function)
• start-crc (function)
• sub-byte (function)
• subup-byte (function)
• unfilter-scanlines (function)
• up-byte (function)
• updated-crc (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *crc-fail-behaviour*

Package

png-read

Source

basic-chunks.lisp (file)

5.1.2 Functions

Function: read-png-datastream PNG-STREAM

Package

png-read

Source

basic-chunks.lisp (file)

Function: read-png-file FILE

Package

png-read

Source

basic-chunks.lisp (file)

5.1.3 Generic functions

Generic Function: bit-depth OBJECT

Generic Function: (setf bit-depth) NEW-VALUE OBJECT

Package

png-read

Methods

Method: bit-depth (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf bit-depth) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: colour-type OBJECT

Generic Function: (setf colour-type) NEW-VALUE OBJECT

Package

png-read

Methods

Method: colour-type (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf colour-type) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: gamma OBJECT

Generic Function: (setf gamma) NEW-VALUE OBJECT

Package

png-read

Methods

Method: gamma (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf gamma) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: height OBJECT

Generic Function: (setf height) NEW-VALUE OBJECT

Package

png-read

Methods

Method: height (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf height) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: image-data OBJECT

Generic Function: (setf image-data) NEW-VALUE OBJECT

Package

png-read

Methods

Method: image-data (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf image-data) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: image-histogram OBJECT

Generic Function: (setf image-histogram) NEW-VALUE OBJECT

Package

png-read

Methods

Method: image-histogram (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf image-histogram) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: last-modification OBJECT

Generic Function: (setf last-modification) NEW-VALUE OBJECT

Package

png-read

Methods

Method: last-modification (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf last-modification) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: palette OBJECT

Generic Function: (setf palette) NEW-VALUE OBJECT

Package

png-read

Methods

Method: palette (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf palette) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: physical-dimensions OBJECT

Generic Function: (setf physical-dimensions) NEW-VALUE OBJECT

Package

png-read

Methods

Method: physical-dimensions (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf physical-dimensions) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: preferred-background OBJECT

Generic Function: (setf preferred-background) NEW-VALUE OBJECT

Package

png-read

Methods

Method: preferred-background (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf preferred-background) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: rendering-intent OBJECT

Generic Function: (setf rendering-intent) NEW-VALUE OBJECT

Package

png-read

Methods

Method: rendering-intent (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf rendering-intent) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: significant-bits OBJECT

Generic Function: (setf significant-bits) NEW-VALUE OBJECT

Package

png-read

Methods

Method: significant-bits (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf significant-bits) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: textual-data OBJECT

Generic Function: (setf textual-data) NEW-VALUE OBJECT

Package

png-read

Methods

Method: textual-data (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf textual-data) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: transparency OBJECT

Generic Function: (setf transparency) NEW-VALUE OBJECT

Package

png-read

Methods

Method: transparency (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf transparency) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: width OBJECT

Generic Function: (setf width) NEW-VALUE OBJECT

Package

png-read

Methods

Method: width (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf width) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

5.1.4 Conditions

Condition: crc-failure ()

Package

png-read

Source

basic-chunks.lisp (file)

Direct superclasses

warning (condition)

Direct methods

• crc-read-of (method)
• crc-is-of (method)
• file-of (method)

Direct slots

Slot: file

Initargs

:file

Readers

file-of (generic function)

Slot: crc-is

Initargs

:crc-is

Readers

crc-is-of (generic function)

Slot: crc-read

Initargs

:crc-read

Readers

crc-read-of (generic function)

5.1.5 Classes

Class: png-state ()

Package

png-read

Source

png-state.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• last-modification (method)
• last-modification (method)
• physical-dimensions (method)
• physical-dimensions (method)
• image-histogram (method)
• image-histogram (method)
• preferred-background (method)
• preferred-background (method)
• textual-data (method)
• textual-data (method)
• rendering-intent (method)
• rendering-intent (method)
• significant-bits (method)
• significant-bits (method)
• gamma (method)
• gamma (method)
• transparency (method)
• transparency (method)
• postprocess-ancillaries (method)
• postprocess-ancillaries (method)
• index-data (method)
• index-data (method)
• image-data (method)
• image-data (method)
• datastream (method)
• datastream (method)
• palette (method)
• palette (method)
• interlace-method (method)
• interlace-method (method)
• filter-method (method)
• filter-method (method)
• compression (method)
• compression (method)
• colour-type (method)
• colour-type (method)
• bit-depth (method)
• bit-depth (method)
• height (method)
• height (method)
• width (method)
• width (method)
• finished (method)
• finished (method)
• png-file (method)
• png-file (method)

Direct slots

Slot: file

Readers

png-file (generic function)

Writers

(setf png-file) (generic function)

Slot: finished

Readers

finished (generic function)

Writers

(setf finished) (generic function)

Slot: width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: bit-depth

Readers

bit-depth (generic function)

Writers

(setf bit-depth) (generic function)

Slot: colour-type

Readers

colour-type (generic function)

Writers

(setf colour-type) (generic function)

Slot: compression

Readers

compression (generic function)

Writers

(setf compression) (generic function)

Slot: filter-method

Readers

filter-method (generic function)

Writers

(setf filter-method) (generic function)

Slot: interlace-method

Readers

interlace-method (generic function)

Writers

(setf interlace-method) (generic function)

Slot: palette

Readers

palette (generic function)

Writers

(setf palette) (generic function)

Slot: datastream

Readers

datastream (generic function)

Writers

(setf datastream) (generic function)

Slot: image-data

Readers

image-data (generic function)

Writers

(setf image-data) (generic function)

Slot: index-data

Readers

index-data (generic function)

Writers

(setf index-data) (generic function)

Slot: postprocess-ancillaries

Readers

postprocess-ancillaries (generic function)

Writers

(setf postprocess-ancillaries) (generic function)

Slot: transparency

Readers

transparency (generic function)

Writers

(setf transparency) (generic function)

Slot: gamma

Readers

gamma (generic function)

Writers

(setf gamma) (generic function)

Slot: significant-bits

Readers

significant-bits (generic function)

Writers

(setf significant-bits) (generic function)

Slot: rendering-intent

Readers

rendering-intent (generic function)

Writers

(setf rendering-intent) (generic function)

Slot: textual-data

Readers

textual-data (generic function)

Writers

(setf textual-data) (generic function)

Slot: preferred-background

Readers

preferred-background (generic function)

Writers

(setf preferred-background) (generic function)

Slot: image-histogram

Readers

image-histogram (generic function)

Writers

(setf image-histogram) (generic function)

Slot: physical-dimensions

Readers

physical-dimensions (generic function)

Writers

(setf physical-dimensions) (generic function)

Slot: last-modification

Readers

last-modification (generic function)

Writers

(setf last-modification) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *adam7*

Package

png-read

Source

deinterlace.lisp (file)

Special Variable: *crc-array*

Package

png-read

Source

crc.lisp (file)

Special Variable: *png-file*

Package

png-read

Source

basic-chunks.lisp (file)

Special Variable: *png-header*

Package

png-read

Source

basic-chunks.lisp (file)

Special Variable: *png-state*

Package

png-read

Source

png-state.lisp (file)

Special Variable: *warn-missing-ancillaries*

Package

png-read

Source

ancillary-chunks.lisp (file)

5.2.2 Compiler macros

Compiler Macro: big-endian-vector-to-integer BYTE-VECTOR-FORM

Package

png-read

Source

util.lisp (file)

5.2.3 Functions

Function: big-endian-vector-to-integer BYTE-VECTOR

Package

png-read

Source

util.lisp (file)

Function: build-transparency-map PNG-STATE

Package

png-read

Source

ancillary-chunks.lisp (file)

Function: crc DATA

Package

png-read

Source

crc.lisp (file)

Function: decode-interlaced DATA PNG-STATE

Package

png-read

Source

deinterlace.lisp (file)

Function: decode-subimages DATA PNG-STATE

Package

png-read

Source

deinterlace.lisp (file)

Function: finish-crc CRC

Package

png-read

Source

crc.lisp (file)

Function: finish-decoding PNG-STATE

Package

png-read

Source

decode.lisp (file)

Function: finish-deinterlace COLOUR-TYPE W H SUB-IMAGES SUB-ARRAYS SUB-HEIGHTS

Package

png-read

Source

deinterlace.lisp (file)

Function: get-height-passlist PASS-LIST

Package

png-read

Source

deinterlace.lisp (file)

Function: get-scanlines DATA H FILTERED-SCANLINE-LENGTH

Package

png-read

Source

decode.lisp (file)

Function: make-crc-array ()

Package

png-read

Source

crc.lisp (file)

Function: make-deinterlace-arrays W H

Package

png-read

Source

deinterlace.lisp (file)

Function: paeth-predictor XI K SCANLINES PIXEL-LENGTH

Package

png-read

Source

decode.lisp (file)

Function: parse-chunk CHUNK-TYPE CHUNK-DATA

Package

png-read

Source

basic-chunks.lisp (file)

Function: read-png-chunks PNG-STREAM

Package

png-read

Source

basic-chunks.lisp (file)

Function: set-image-slice-to-index X Y IDX PALETTE IMAGE-DATA

Package

png-read

Source

decode.lisp (file)

Function: split-datastream DATASTREAM BD COLOUR-TYPE SUB-WIDTHS SUB-HEIGHTS

Package

png-read

Source

deinterlace.lisp (file)

Function: start-crc DATA

Package

png-read

Source

crc.lisp (file)

Function: sub-byte XI SCANLINE PIXEL-LENGTH

Package

png-read

Source

decode.lisp (file)

Function: subup-byte XI K SCANLINES PIXEL-LENGTH

Package

png-read

Source

decode.lisp (file)

Function: unfilter-scanlines SCANLINES PIXEL-LENGTH

Package

png-read

Source

decode.lisp (file)

Function: up-byte XI K SCANLINES

Package

png-read

Source

decode.lisp (file)

Function: updated-crc CRC DATA

Package

png-read

Source

crc.lisp (file)

5.2.4 Generic functions

Generic Function: compression OBJECT

Generic Function: (setf compression) NEW-VALUE OBJECT

Package

png-read

Methods

Method: compression (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf compression) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: crc-is-of CONDITION

Package

png-read

Methods

Method: crc-is-of (CONDITION crc-failure)

Source

basic-chunks.lisp (file)

Generic Function: crc-read-of CONDITION

Package

png-read

Methods

Method: crc-read-of (CONDITION crc-failure)

Source

basic-chunks.lisp (file)

Generic Function: datastream OBJECT

Generic Function: (setf datastream) NEW-VALUE OBJECT

Package

png-read

Methods

Method: datastream (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf datastream) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: decode-data COLOUR-TYPE DATA PNG-STATE

Package

png-read

Source

decode.lisp (file)

Methods

Method: decode-data (COLOUR-TYPE (eql truecolor-alpha)) DATA PNG-STATE

Method: decode-data (COLOUR-TYPE (eql greyscale-alpha)) DATA PNG-STATE

Method: decode-data (COLOUR-TYPE (eql indexed-colour)) DATA PNG-STATE

Method: decode-data (COLOUR-TYPE (eql truecolor)) DATA PNG-STATE

Method: decode-data (COLOUR-TYPE (eql greyscale)) DATA PNG-STATE

Generic Function: file-of CONDITION

Package

png-read

Methods

Method: file-of (CONDITION crc-failure)

Source

basic-chunks.lisp (file)

Generic Function: filter-method OBJECT

Generic Function: (setf filter-method) NEW-VALUE OBJECT

Package

png-read

Methods

Method: filter-method (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf filter-method) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: finished OBJECT

Generic Function: (setf finished) NEW-VALUE OBJECT

Package

png-read

Methods

Method: finished (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf finished) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: index-data OBJECT

Generic Function: (setf index-data) NEW-VALUE OBJECT

Package

png-read

Methods

Method: index-data (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf index-data) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: interlace-method OBJECT

Generic Function: (setf interlace-method) NEW-VALUE OBJECT

Package

png-read

Methods

Method: interlace-method (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf interlace-method) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: parse-ancillary-chunk CHUNK-TYPE CHUNK-DATA

Package

png-read

Source

ancillary-chunks.lisp (file)

Methods

Method: parse-ancillary-chunk (CHUNK-TYPE (eql time)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql phys)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql hist)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql bkgd)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql itxt)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql ztxt)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql text)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql srgb)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql sbit)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql gama)) CHUNK-DATA

Method: parse-ancillary-chunk (CHUNK-TYPE (eql trns)) CHUNK-DATA

Method: parse-ancillary-chunk CHUNK-TYPE CHUNK-DATA

Generic Function: parse-critical-chunk CHUNK-TYPE CHUNK-DATA

Package

png-read

Source

critical-chunks.lisp (file)

Methods

Method: parse-critical-chunk (CHUNK-TYPE (eql iend)) CHUNK-DATA

Method: parse-critical-chunk (CHUNK-TYPE (eql idat)) CHUNK-DATA

Method: parse-critical-chunk (CHUNK-TYPE (eql plte)) CHUNK-DATA

Method: parse-critical-chunk (CHUNK-TYPE (eql ihdr)) CHUNK-DATA

Method: parse-critical-chunk CHUNK-TYPE CHUNK-DATA

Generic Function: png-file OBJECT

Generic Function: (setf png-file) NEW-VALUE OBJECT

Package

png-read

Methods

Method: png-file (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf png-file) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Generic Function: postprocess-ancillaries OBJECT

Generic Function: (setf postprocess-ancillaries) NEW-VALUE OBJECT

Package

png-read

Methods

Method: postprocess-ancillaries (PNG-STATE png-state)

automatically generated reader method

Source

png-state.lisp (file)

Method: (setf postprocess-ancillaries) NEW-VALUE (PNG-STATE png-state)

automatically generated writer method

Source

png-state.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables