The zpb-exif Reference Manual

Table of Contents

The zpb-exif Reference Manual

This is the zpb-exif Reference Manual, version 1.2.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 19:32:54 2020 GMT+0.

1 Introduction

ZPB-EXIF can read EXIF data from image files. It is available under a
BSD-like license.

For documentation, see doc/index.html.

For any questions and comments, please email Zach Beane
.

2 Systems

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

2.1 zpb-exif

Author

Zachary Beane <xach@xach.com>

License

BSD

Description

Read EXIF data from image files

Version

1.2.3

Source

zpb-exif.asd (file)

Component

exif.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 zpb-exif.asd

Location

zpb-exif.asd

Systems

zpb-exif (system)

3.1.2 zpb-exif/exif.lisp

Parent

zpb-exif (system)

Location

exif.lisp

Packages

zpb-exif

Exported Definitions

• entry-value (function)
• exif-alist (function)
• exif-data (function)
• exif-ifd (method)
• (setf exif-ifd) (method)
• exif-value (function)
• gps-ifd (method)
• (setf gps-ifd) (method)
• ifd-alist (function)
• ifd-entry (function)
• ifd-entry (class)
• image-ifd (method)
• (setf image-ifd) (method)
• interoperability-ifd (method)
• (setf interoperability-ifd) (method)
• invalid-exif-stream (condition)
• invalid-jpeg-stream (condition)
• invalid-stream (condition)
• make-exif (function)
• parse-exif-data (function)
• parsed-entry-value (function)
• parsed-exif-value (function)
• thumbnail-ifd (method)
• (setf thumbnail-ifd) (method)
• thumbnail-image (function)

Internal Definitions

• %ifd-entry (function)
• %value (method)
• *optimizations* (special variable)
• *reader-functions/lsb* (special variable)
• *reader-functions/msb* (special variable)
• *type-readers* (special variable)
• bisect-find (function)
• check-bytes (function)
• count (method)
• data (method)
• define-exif-type (macro)
• define-tagset (macro)
• do-gets (macro)
• endianness (method)
• entries (method)
• (setf entries) (method)
• exif (method)
• exif (class)
• exif-type-parser-fun (function)
• file (method)
• find-ifd-entry (function)
• get-16 (function)
• get-16-function (method)
• get-16/lsb (function)
• get-16/msb (function)
• get-32 (function)
• get-32-function (method)
• get-32/lsb (function)
• get-32/msb (function)
• get-8 (function)
• get-8/* (function)
• get-ascii (function)
• get-byte (function)
• get-long (function)
• get-rational (function)
• get-short (function)
• get-slong (function)
• get-srational (function)
• get-string (function)
• get-undefined (function)
• get-unknown-type (function)
• ifd (method)
• ifd (class)
• immediate-value-p (function)
• initialize-exif-ifds (function)
• initialize-ifd-entry (function)
• long->slong (function)
• make-exif-from-file (function)
• make-exif-from-stream (function)
• name (method)
• next-ifd-offset (method)
• (setf next-ifd-offset) (method)
• offset (method)
• parse-datetime (function)
• read-ifd (function)
• read-ifd-entry (function)
• read-ifd-value (function)
• read-jpeg-uint16 (function)
• seek-to-app1 (function)
• tag (method)
• tag (method)
• tag-code (function)
• tag-designator (function)
• tag-name (function)
• tag-type (function)
• tagset (method)
• (setf tagset) (method)
• tagset-entry (class)
• type (method)
• type (method)
• (setf value) (method)
• value-offset (method)

4 Packages

Packages are listed by definition order.

4.1 zpb-exif

Source

exif.lisp (file)

Use List

common-lisp

Exported Definitions

• entry-value (function)
• exif-alist (function)
• exif-data (function)
• exif-ifd (generic function)
• exif-ifd (method)
• (setf exif-ifd) (method)
• (setf exif-ifd) (generic function)
• exif-value (function)
• gps-ifd (generic function)
• gps-ifd (method)
• (setf gps-ifd) (method)
• (setf gps-ifd) (generic function)
• ifd-alist (function)
• ifd-entry (function)
• ifd-entry (class)
• image-ifd (generic function)
• image-ifd (method)
• (setf image-ifd) (method)
• (setf image-ifd) (generic function)
• interoperability-ifd (generic function)
• interoperability-ifd (method)
• (setf interoperability-ifd) (method)
• (setf interoperability-ifd) (generic function)
• invalid-exif-stream (condition)
• invalid-jpeg-stream (condition)
• invalid-stream (condition)
• make-exif (function)
• parse-exif-data (function)
• parsed-entry-value (function)
• parsed-exif-value (function)
• thumbnail-ifd (generic function)
• thumbnail-ifd (method)
• (setf thumbnail-ifd) (method)
• (setf thumbnail-ifd) (generic function)
• thumbnail-image (function)

Internal Definitions

• %ifd-entry (function)
• %value (generic function)
• %value (method)
• *optimizations* (special variable)
• *reader-functions/lsb* (special variable)
• *reader-functions/msb* (special variable)
• *type-readers* (special variable)
• bisect-find (function)
• check-bytes (function)
• count (generic function)
• count (method)
• data (generic function)
• data (method)
• define-exif-type (macro)
• define-tagset (macro)
• do-gets (macro)
• endianness (generic function)
• endianness (method)
• entries (generic function)
• entries (method)
• (setf entries) (method)
• (setf entries) (generic function)
• exif (generic function)
• exif (method)
• exif (class)
• exif-type-parser-fun (function)
• file (generic function)
• file (method)
• find-ifd-entry (function)
• get-16 (function)
• get-16-function (generic function)
• get-16-function (method)
• get-16/lsb (function)
• get-16/msb (function)
• get-32 (function)
• get-32-function (generic function)
• get-32-function (method)
• get-32/lsb (function)
• get-32/msb (function)
• get-8 (function)
• get-8/* (function)
• get-ascii (function)
• get-byte (function)
• get-long (function)
• get-rational (function)
• get-short (function)
• get-slong (function)
• get-srational (function)
• get-string (function)
• get-undefined (function)
• get-unknown-type (function)
• ifd (generic function)
• ifd (method)
• ifd (class)
• immediate-value-p (function)
• initialize-exif-ifds (function)
• initialize-ifd-entry (function)
• long->slong (function)
• make-exif-from-file (function)
• make-exif-from-stream (function)
• name (generic function)
• name (method)
• next-ifd-offset (generic function)
• next-ifd-offset (method)
• (setf next-ifd-offset) (method)
• (setf next-ifd-offset) (generic function)
• offset (generic function)
• offset (method)
• parse-datetime (function)
• read-ifd (function)
• read-ifd-entry (function)
• read-ifd-value (function)
• read-jpeg-uint16 (function)
• seek-to-app1 (function)
• tag (generic function)
• tag (method)
• tag (method)
• tag-code (function)
• tag-designator (function)
• tag-name (function)
• tag-type (function)
• tagset (generic function)
• tagset (method)
• (setf tagset) (method)
• (setf tagset) (generic function)
• tagset-entry (class)
• type (generic function)
• type (method)
• type (method)
• (setf value) (generic function)
• (setf value) (method)
• value-offset (generic function)
• value-offset (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: entry-value IFD-ENTRY

Package

zpb-exif

Source

exif.lisp (file)

Function: exif-alist EXIF &key PARSEDP

Return the keys and values from the Image, Exif, and GPS IFDs of EXIF.

Package

zpb-exif

Source

exif.lisp (file)

Function: exif-data EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: exif-value TAG EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: ifd-alist IFD &key PARSEDP

Return all the values in IFD as an alist.

Package

zpb-exif

Source

exif.lisp (file)

Function: ifd-entry TAG IFD

Package

zpb-exif

Source

exif.lisp (file)

Function: make-exif OBJECT

Read and create an exif object from OBJECT, which may be a pathname designator or a stream.

Package

zpb-exif

Source

exif.lisp (file)

Function: parse-exif-data FILE

Package

zpb-exif

Source

exif.lisp (file)

Function: parsed-entry-value IFD-ENTRY

Package

zpb-exif

Source

exif.lisp (file)

Function: parsed-exif-value TAG EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: thumbnail-image EXIF

Return an (UNSIGNED-BYTE 8) vector containing the JPEG data for the thumbnail image in EXIF, if present. If there is no thumbnail, return NIL.

Package

zpb-exif

Source

exif.lisp (file)

5.1.2 Generic functions

Generic Function: exif-ifd OBJECT

Generic Function: (setf exif-ifd) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: exif-ifd (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf exif-ifd) NEW-VALUE (EXIF exif)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: gps-ifd OBJECT

Generic Function: (setf gps-ifd) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: gps-ifd (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf gps-ifd) NEW-VALUE (EXIF exif)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: image-ifd OBJECT

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

Package

zpb-exif

Methods

Method: image-ifd (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf image-ifd) NEW-VALUE (EXIF exif)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: interoperability-ifd OBJECT

Generic Function: (setf interoperability-ifd) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: interoperability-ifd (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf interoperability-ifd) NEW-VALUE (EXIF exif)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: thumbnail-ifd OBJECT

Generic Function: (setf thumbnail-ifd) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: thumbnail-ifd (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf thumbnail-ifd) NEW-VALUE (EXIF exif)

automatically generated writer method

Source

exif.lisp (file)

5.1.3 Conditions

Condition: invalid-exif-stream ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

invalid-stream (condition)

Condition: invalid-jpeg-stream ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

invalid-stream (condition)

Condition: invalid-stream ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• invalid-jpeg-stream (condition)
• invalid-exif-stream (condition)

5.1.4 Classes

Class: ifd-entry ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• (setf value) (method)
• %value (method)
• value-offset (method)
• count (method)
• type (method)
• tag (method)
• ifd (method)
• exif (method)

Direct slots

Slot: exif

Initargs

:exif

Readers

exif (generic function)

Slot: ifd

Initargs

:ifd

Readers

ifd (generic function)

Slot: tag

Initargs

:tag

Readers

tag (generic function)

Slot: type

Initargs

:type

Readers

type (generic function)

Slot: count

Initargs

:count

Readers

count (generic function)

Slot: value-offset

Initargs

:value-offset

Readers

value-offset (generic function)

Slot: value

Initargs

:value

Readers

%value (generic function)

Writers

(setf value) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *optimizations*

Package

zpb-exif

Source

exif.lisp (file)

Special Variable: *reader-functions/lsb*

Package

zpb-exif

Source

exif.lisp (file)

Special Variable: *reader-functions/msb*

Package

zpb-exif

Source

exif.lisp (file)

Special Variable: *type-readers*

Package

zpb-exif

Source

exif.lisp (file)

5.2.2 Macros

Macro: define-exif-type NAME (BASE-TYPE) &rest OPTIONS

Package

zpb-exif

Source

exif.lisp (file)

Macro: define-tagset NAME &body TAG-DEFINITIONS

Package

zpb-exif

Source

exif.lisp (file)

Macro: do-gets (J START STEP COUNT) &body BODY

Evaluate BODY COUNT times, binding J to START initially, then incrementing it by STEP. The results of the evaluation are returned as a vector.

Package

zpb-exif

Source

exif.lisp (file)

5.2.3 Functions

Function: %ifd-entry TAG IFD

Package

zpb-exif

Source

exif.lisp (file)

Function: bisect-find OBJECT VECTOR &key KEY

Package

zpb-exif

Source

exif.lisp (file)

Function: check-bytes STREAM &rest BYTES

Return true if next bytes of STREAM match the list BYTES.

Package

zpb-exif

Source

exif.lisp (file)

Function: exif-type-parser-fun EXIF-TYPE

Package

zpb-exif

Source

exif.lisp (file)

Function: find-ifd-entry TAG EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-16 POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-16/lsb POS BUF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-16/msb POS BUF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-32 POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-32/lsb POS BUF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-32/msb POS BUF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-8 POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-8/* POS BUF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-ascii TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-byte TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-long TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-rational TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-short TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-slong TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-srational TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-string POS LENGTH EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-undefined TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: get-unknown-type TYPE &rest ARGS

Package

zpb-exif

Source

exif.lisp (file)

Function: immediate-value-p TYPE COUNT

Can COUNT items of TYPE be stored in the 32-bit IFD entry value offset area?

Package

zpb-exif

Source

exif.lisp (file)

Function: initialize-exif-ifds EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: initialize-ifd-entry IFD-ENTRY

Package

zpb-exif

Source

exif.lisp (file)

Function: long->slong LONG

Package

zpb-exif

Source

exif.lisp (file)

Function: make-exif-from-file FILE

Package

zpb-exif

Source

exif.lisp (file)

Function: make-exif-from-stream STREAM

Extract an Exif object from the open (unsigned-byte 8) STREAM. The stream must be positioned at the beginning of JPEG data. If the stream is not a JPEG stream, raise INVALID-JPEG-STREAM. If the stream does not contain Exif data, raise INVALID-EXIF-STREAM.

Package

zpb-exif

Source

exif.lisp (file)

Function: parse-datetime STRING

Convert an Exif datetime string in the form "YYYY:MM:DD hh:mm:ss" to a universal time.

Package

zpb-exif

Source

exif.lisp (file)

Function: read-ifd POS TAGSET EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: read-ifd-entry POS IFD EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: read-ifd-value TYPE COUNT POS EXIF

Package

zpb-exif

Source

exif.lisp (file)

Function: read-jpeg-uint16 STREAM

Package

zpb-exif

Source

exif.lisp (file)

Function: seek-to-app1 STREAM

Position STREAM after the #xFF, #xE1 marker in the JPEG stream representing the APP1 segment. Raise an INVALID-EXIF-STREAM error if no APP1 segment can be found.

Package

zpb-exif

Source

exif.lisp (file)

Function: tag-code NAME TAGSET

Package

zpb-exif

Source

exif.lisp (file)

Function: tag-designator TAG TAGSET

Package

zpb-exif

Source

exif.lisp (file)

Function: tag-name CODE TAGSET

Package

zpb-exif

Source

exif.lisp (file)

Function: tag-type CODE TAGSET

Package

zpb-exif

Source

exif.lisp (file)

5.2.4 Generic functions

Generic Function: %value OBJECT

Package

zpb-exif

Methods

Method: %value (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: count OBJECT

Package

zpb-exif

Methods

Method: count (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: data OBJECT

Package

zpb-exif

Methods

Method: data (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: endianness OBJECT

Package

zpb-exif

Methods

Method: endianness (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: entries OBJECT

Generic Function: (setf entries) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: entries (IFD ifd)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf entries) NEW-VALUE (IFD ifd)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: exif OBJECT

Package

zpb-exif

Methods

Method: exif (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: file OBJECT

Package

zpb-exif

Methods

Method: file (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: get-16-function OBJECT

Package

zpb-exif

Methods

Method: get-16-function (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: get-32-function OBJECT

Package

zpb-exif

Methods

Method: get-32-function (EXIF exif)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: ifd OBJECT

Package

zpb-exif

Methods

Method: ifd (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: name OBJECT

Package

zpb-exif

Methods

Method: name (TAGSET-ENTRY tagset-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: next-ifd-offset OBJECT

Generic Function: (setf next-ifd-offset) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: next-ifd-offset (IFD ifd)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf next-ifd-offset) NEW-VALUE (IFD ifd)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: offset OBJECT

Package

zpb-exif

Methods

Method: offset (EXIF exif)

The position in the input stream from where the Exif data was read.

Source

exif.lisp (file)

Generic Function: tag OBJECT

Package

zpb-exif

Methods

Method: tag (TAGSET-ENTRY tagset-entry)

automatically generated reader method

Source

exif.lisp (file)

Method: tag (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: tagset OBJECT

Generic Function: (setf tagset) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: tagset (IFD ifd)

automatically generated reader method

Source

exif.lisp (file)

Method: (setf tagset) NEW-VALUE (IFD ifd)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: type OBJECT

Package

zpb-exif

Methods

Method: type (TAGSET-ENTRY tagset-entry)

automatically generated reader method

Source

exif.lisp (file)

Method: type (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

Generic Function: (setf value) NEW-VALUE OBJECT

Package

zpb-exif

Methods

Method: (setf value) NEW-VALUE (IFD-ENTRY ifd-entry)

automatically generated writer method

Source

exif.lisp (file)

Generic Function: value-offset OBJECT

Package

zpb-exif

Methods

Method: value-offset (IFD-ENTRY ifd-entry)

automatically generated reader method

Source

exif.lisp (file)

5.2.5 Classes

Class: exif ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• interoperability-ifd (method)
• interoperability-ifd (method)
• gps-ifd (method)
• gps-ifd (method)
• exif-ifd (method)
• exif-ifd (method)
• thumbnail-ifd (method)
• thumbnail-ifd (method)
• image-ifd (method)
• image-ifd (method)
• endianness (method)
• get-16-function (method)
• get-32-function (method)
• offset (method)
• data (method)
• file (method)

Direct slots

Slot: file

Initargs

:file

Readers

file (generic function)

Slot: data

Initargs

:data

Readers

data (generic function)

Slot: offset

The position in the input stream from where the Exif data was read.

Initargs

:offset

Readers

offset (generic function)

Slot: get-32-function

Initargs

:get-32-function

Readers

get-32-function (generic function)

Slot: get-16-function

Initargs

:get-16-function

Readers

get-16-function (generic function)

Slot: endianness

Initargs

:endianness

Readers

endianness (generic function)

Slot: image-ifd

Initargs

:image-ifd

Readers

image-ifd (generic function)

Writers

(setf image-ifd) (generic function)

Slot: thumbnail-ifd

Initargs

:thumbnail-ifd

Readers

thumbnail-ifd (generic function)

Writers

(setf thumbnail-ifd) (generic function)

Slot: exif-ifd

Initargs

:exif-ifd

Readers

exif-ifd (generic function)

Writers

(setf exif-ifd) (generic function)

Slot: gps-ifd

Initargs

:gps-ifd

Readers

gps-ifd (generic function)

Writers

(setf gps-ifd) (generic function)

Slot: interoperability-ifd

Initargs

:interoperability-ifd

Readers

interoperability-ifd (generic function)

Writers

(setf interoperability-ifd) (generic function)

Class: ifd ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• next-ifd-offset (method)
• next-ifd-offset (method)
• entries (method)
• entries (method)
• tagset (method)
• tagset (method)

Direct slots

Slot: tagset

Initargs

:tagset

Readers

tagset (generic function)

Writers

(setf tagset) (generic function)

Slot: entries

Initargs

:entries

Readers

entries (generic function)

Writers

(setf entries) (generic function)

Slot: next-ifd-offset

Initargs

:next-ifd-offset

Initform

0

Readers

next-ifd-offset (generic function)

Writers

(setf next-ifd-offset) (generic function)

Class: tagset-entry ()

Package

zpb-exif

Source

exif.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• type (method)
• name (method)
• tag (method)

Direct slots

Slot: tag

Initargs

:tag

Readers

tag (generic function)

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: type

Initargs

:type

Readers

type (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types