[proj16/16.git] / 16 / PCGPE10 / IFF.DOC

\r
\r
"EA IFF 85" Standard for Interchange Format Files\r
\r
Document Date:          January 14, 1985\r
From:                   Jerry Morrison, Electronic Arts\r
Status of Standard:     Released and in use\r
\r
1. Introduction\r
\r
Standards are Good for Software Developers\r
\r
As home computer hardware evolves to better and better media machines, \r
the demand increases for higher quality, more detailed data. Data \r
development gets more expensive, requires more expertise and better \r
tools, and has to be shared across projects. Think about several ports \r
of a product on one CD-ROM with 500M Bytes of common data!\r
\r
Development tools need standard interchange file formats. Imagine \r
scanning in images of "player" shapes, moving them to a paint program \r
for editing, then incorporating them into a game. Or writing a theme \r
song with a Macintosh score editor and incorporating it into an Amiga \r
game. The data must at times be transformed, clipped, filled out, \r
and moved across machine kinds. Media projects will depend on data \r
transfer from graphic, music, sound effect, animation, and script \r
tools.\r
\r
Standards are Good for Software Users\r
\r
Customers should be able to move their own data between independently \r
developed software products. And they should be able to buy data libraries \r
usable across many such products. The types of data objects to exchange \r
are open-ended and include plain and formatted text, raster and structured \r
graphics, fonts, music, sound effects, musical instrument descriptions, \r
and animation.\r
\r
The problem with expedient file formats typically memory dumps is \r
that they're too provincial. By designing data for one particular \r
use (e.g. a screen snapshot), they preclude future expansion (would \r
you like a full page picture? a multi-page document?). In neglecting \r
the possibility that other programs might read their data, they fail \r
to save contextual information (how many bit planes? what resolution?). \r
Ignoring that other programs might create such files, they're intolerant \r
of extra data (texture palette for a picture editor), missing data \r
(no color map), or minor variations (smaller image). In practice, \r
a filed representation should rarely mirror an in-memory representation. \r
The former should be designed for longevity; the latter to optimize \r
the manipulations of a particular program. The same filed data will \r
be read into different memory formats by different programs.\r
\r
The IFF philosophy: "A little behind-the-scenes conversion when programs \r
read and write files is far better than NxM explicit conversion utilities \r
for highly specialized formats."\r
\r
So we need some standardization for data interchange among development \r
tools and products. The more developers that adopt a standard, the \r
better for all of us and our customers.\r
\r
Here is "EA IFF 1985"\r
\r
Here is our offering: Electronic Arts' IFF standard for Interchange \r
File Format. The full name is "EA IFF 1985". Alternatives and justifications \r
are included for certain choices. Public domain subroutine packages \r
and utility programs are available to make it easy to write and use \r
IFF-compatible programs.\r
\r
Part 1 introduces the standard. Part 2 presents its requirements and \r
background. Parts 3, 4, and 5 define the primitive data types, FORMs, \r
and LISTs, respectively, and how to define new high level types. Part \r
6 specifies the top level file structure. Appendix A is included for \r
quick reference and Appendix B names the committee responsible for \r
this standard.\r
\r
References\r
\r
American National Standard Additional Control Codes for Use with ASCII, \r
ANSI standard 3.64-1979 for an 8-bit character set. See also ISO standard \r
2022 and ISO/DIS standard 6429.2.\r
\r
Amiga[tm] is a trademark of Commodore-Amiga, Inc.\r
\r
C, A Reference Manual, Samuel P. Harbison and Guy L. Steele Jr., Tartan \r
Laboratories. Prentice-Hall, Englewood Cliffs, NJ, 1984.\r
\r
Compiler Construction, An Advanced Course, edited by F. L. Bauer and \r
J. Eickel (Springer-Verlag, 1976). This book is one of many sources \r
for information on recursive descent parsing.\r
\r
DIF Technical Specification (c)1981 by Software Arts, Inc. DIF[tm] is \r
the format for spreadsheet data interchange developed by Software \r
Arts, Inc.\r
DIF[tm] is a trademark of Software Arts, Inc.\r
\r
Electronic Arts[tm] is a trademark of Electronic Arts.\r
\r
"FTXT" IFF Formatted Text, from Electronic Arts. IFF supplement document \r
for a text format.\r
\r
Inside Macintosh (c) 1982, 1983, 1984, 1985 Apple Computer, Inc., a \r
programmer's reference manual.\r
Apple(R) is a trademark of Apple Computer, Inc.\r
Macintosh[tm] is a trademark licensed to Apple Computer, Inc.\r
\r
"ILBM" IFF Interleaved Bitmap, from Electronic Arts. IFF supplement \r
document for a raster image format.\r
\r
M68000 16/32-Bit Microprocessor Programmer's Reference Manual(c) 1984, \r
1982, 1980, 1979 by Motorola, Inc.\r
\r
PostScript Language Manual (c) 1984 Adobe Systems Incorporated.\r
PostScript[tm] is a trademark of Adobe Systems, Inc.\r
Times and Helvetica(R) are trademarks of Allied Corporation.\r
\r
InterScript: A Proposal for a Standard for the Interchange of Editable \r
Documents (c)1984 Xerox Corporation.\r
Introduction to InterScript (c) 1985 Xerox Corporation.\r
\r
\r
\f\r
2. Background for Designers\r
\r
Part 2 is about the background, requirements, and goals for the standard. \r
It's geared for people who want to design new types of IFF objects. \r
People just interested in using the standard may wish to skip this \r
part.\r
\r
What Do We Need?\r
\r
A standard should be long on prescription and short on overhead. It \r
should give lots of rules for designing programs and data files for \r
synergy. But neither the programs nor the files should cost too much \r
more than the expedient variety. While we're looking to a future with \r
CD-ROMs and perpendicular recording, the standard must work well on \r
floppy disks.\r
\r
For program portability, simplicity, and efficiency, formats should \r
be designed with more than one implementation style in mind. (In practice, \r
pure stream I/O is adequate although random access makes it easier \r
to write files.) It ought to be possible to read one of many objects \r
in a file without scanning all the preceding data. Some programs need \r
to read and play out their data in real time, so we need good compromises \r
between generality and efficiency.\r
\r
As much as we need standards, they can't hold up product schedules. \r
So we also need a kind of decentralized extensibility where any software \r
developer can define and refine new object types without some "standards \r
authority" in the loop. Developers must be able to extend existing \r
formats in a forward- and backward-compatible way. A central repository \r
for design information and example programs can help us take full \r
advantage of the standard.\r
\r
For convenience, data formats should heed the restrictions of various \r
processors and environments. E.g. word-alignment greatly helps 68000 \r
access at insignificant cost to 8088 programs.\r
\r
Other goals include the ability to share common elements over a list \r
of objects and the ability to construct composite objects containing \r
other data objects with structural information like directories.\r
\r
And finally, "Simple things should be simple and complex things should \r
be possible."   Alan Kay.\r
\r
Think Ahead\r
\r
Let's think ahead and build programs that read and write files for \r
each other and for programs yet to be designed. Build data formats \r
to last for future computers so long as the overhead is acceptable. \r
This extends the usefulness and life of today's programs and data.\r
\r
To maximize interconnectivity, the standard file structure and the \r
specific object formats must all be general and extensible. Think \r
ahead when designing an object. It should serve many purposes and \r
allow many programs to store and read back all the information they \r
need; even squeeze in custom data. Then a programmer can store the \r
available data and is encouraged to include fixed contextual details. \r
Recipient programs can read the needed parts, skip unrecognized stuff, \r
default missing data, and use the stored context to help transform \r
the data as needed.\r
\r
Scope\r
\r
IFF addresses these needs by defining a standard file structure, some \r
initial data object types, ways to define new types, and rules for \r
accessing these files. We can accomplish a great deal by writing programs \r
according to this standard, but don't expect direct compatibility \r
with existing software. We'll need conversion programs to bridge the \r
gap from the old world.\r
\r
IFF is geared for computers that readily process information in 8-bit \r
bytes. It assumes a "physical layer" of data storage and transmission \r
that reliably maintains "files" as strings of 8-bit bytes. The standard \r
treats a "file" as a container of data bytes and is independent of \r
how to find a file and whether it has a byte count.\r
\r
This standard does not by itself implement a clipboard for cutting \r
and pasting data between programs. A clipboard needs software to mediate \r
access, to maintain a "contents version number" so programs can detect \r
updates, and to manage the data in "virtual memory".\r
\r
Data Abstraction\r
\r
The basic problem is how to represent information  in a way that's \r
program-independent, compiler- independent, machine-independent, and \r
device-independent.\r
\r
The computer science approach is "data abstraction", also known as \r
"objects", "actors", and "abstract data types". A data abstraction \r
has a "concrete representation" (its storage format), an "abstract \r
representation" (its capabilities and uses), and access procedures \r
that isolate all the calling software from the concrete representation. \r
Only the access procedures touch the data storage. Hiding mutable \r
details behind an interface is called "information hiding". What data \r
abstraction does is abstract from details of implementing the object, \r
namely the selected storage representation and algorithms for manipulating \r
it.\r
\r
The power of this approach is modularity. By adjusting the access \r
procedures we can extend and restructure the data without impacting \r
the interface or its callers. Conversely, we can extend and restructure \r
the interface and callers without making existing data obsolete. It's \r
great for interchange!\r
\r
But we seem to need the opposite: fixed file formats for all programs \r
to access. Actually, we could file data abstractions ("filed objects") \r
by storing the data and access procedures together. We'd have to encode \r
the access procedures in a standard machine-independent programming \r
language   la PostScript. Even still, the interface can't evolve freely \r
since we can't update all copies of the access procedures. So we'll \r
have to design our abstract representations for limited evolution \r
and occasional revolution (conversion).\r
\r
In any case, today's microcomputers can't practically store data abstractions. \r
They can do the next best thing: store arbitrary types of data in \r
"data chunks", each with a type identifier and a length count. The \r
type identifier is a reference by name to the access procedures (any \r
local implementation). The length count enables storage-level object \r
operations like "copy" and "skip to next" independent of object type.\r
\r
Chunk writing is straightforward. Chunk reading requires a trivial \r
parser to scan each chunk and dispatch to the proper access/conversion \r
procedure. Reading chunks nested inside other chunks requires recursion, \r
but no lookahead or backup.\r
\r
That's the main idea of IFF. There are, of course, a few other detailsI\r
\r
Previous Work\r
\r
Where our needs are similar, we borrow from existing standards.\r
\r
Our basic need to move data between independently developed programs \r
is similar to that addressed by the Apple Macintosh desk scrap or \r
"clipboard" [Inside Macintosh chapter "Scrap Manager"]. The Scrap \r
Manager works closely with the Resource Manager, a handy filer and \r
swapper for data objects (text strings, dialog window templates, pictures, \r
fontsI) including types yet to be designed [Inside Macintosh chapter \r
"Resource Manager"]. The Resource Manager is a kin to Smalltalk's \r
object swapper.\r
\r
We will probably write a Macintosh desk accessory that converts IFF \r
files to and from the Macintosh clipboard for quick and easy interchange \r
with programs like MacPaint and Resource Mover.\r
\r
Macintosh uses a simple and elegant scheme of 4-character "identifiers" \r
to identify resource types, clipboard format types, file types, and \r
file creator programs. Alternatives are unique ID numbers assigned \r
by a central authority or by hierarchical authorities, unique ID numbers \r
generated by algorithm, other fixed length character strings, and \r
variable length strings. Character string identifiers double as readable \r
signposts in data files and programs. The choice of 4 characters is \r
a good tradeoff between storage space, fetch/compare/store time, and \r
name space size. We'll honor Apple's designers by adopting this scheme.\r
\r
"PICT" is a good example of a standard structured graphics format \r
(including raster images) and its many uses [Inside Macintosh chapter \r
"QuickDraw"]. Macintosh provides QuickDraw routines in ROM to create, \r
manipulate, and display PICTs. Any application can create a PICT by \r
simply asking QuickDraw to record a sequence of drawing commands. \r
Since it's just as easy to ask QuickDraw to render a PICT to a screen \r
or a printer, it's very effective to pass them between programs, say \r
from an illustrator to a word processor. An important feature is the \r
ability to store "comments" in a PICT which QuickDraw will ignore. \r
Actually, it passes them to your optional custom "comment handler".\r
\r
PostScript, Adobe's print file standard, is a more general way to \r
represent any print image (which is a specification for putting marks \r
on paper) [PostScript Language Manual]. In fact, PostScript is a full-fledged \r
programming language. To interpret a PostScript program is to render \r
a document on a raster output device. The language is defined in layers: \r
a lexical layer of identifiers, constants, and operators; a layer \r
of reverse polish semantics including scope rules and a way to define \r
new subroutines; and a printing-specific layer of built-in identifiers \r
and operators for rendering graphic images. It is clearly a powerful \r
(Turing equivalent) image definition language. PICT and a subset of \r
PostScript are candidates for structured graphics standards.\r
\r
A PostScript document can be printed on any raster output device (including \r
a display) but cannot generally be edited. That's because the original \r
flexibility and constraints have been discarded. Besides, a PostScript \r
program may use arbitrary computation to supply parameters like placement \r
and size to each operator. A QuickDraw PICT, in comparison, is a more \r
restricted format of graphic primitives parameterized by constants. \r
So a PICT can be edited at the level of the primitives, e.g. move \r
or thicken a line. It cannot be edited at the higher level of, say, \r
the bar chart data which generated the picture.\r
\r
PostScript has another limitation: Not all kinds of data amount to \r
marks on paper. A musical instrument description is one example. PostScript \r
is just not geared for such uses.\r
\r
"DIF" is another example of data being stored in a general format \r
usable by future programs [DIF Technical Specification]. DIF is a \r
format for spreadsheet data interchange. DIF and PostScript are both \r
expressed in plain ASCII text files. This is very handy for printing, \r
debugging, experimenting, and transmitting across modems. It can have \r
substantial cost in compaction and read/write work, depending on use. \r
We won't store IFF files this way but we could define an ASCII alternate \r
representation with a converter program.\r
\r
InterScript is Xerox' standard for interchange of editable documents \r
[Introduction to InterScript]. It approaches a harder problem: How \r
to represent editable word processor documents that may contain formatted \r
text, pictures, cross-references like figure numbers, and even highly \r
specialized objects like mathematical equations? InterScript aims \r
to define one standard representation for each kind of information. \r
Each InterScript-compatible editor is supposed to preserve the objects \r
it doesn't understand and even maintain nested cross-references. So \r
a simple word processor would let you edit the text of a fancy document \r
without discarding the equations or disrupting the equation numbers.\r
\r
Our task is similarly to store high level information and preserve \r
as much content as practical while moving it between programs. But \r
we need to span a larger universe of data types and cannot expect \r
to centrally define them all. Fortunately, we don't need to make programs \r
preserve information that they don't understand. And for better or \r
worse, we don't have to tackle general-purpose cross-references yet.\r
\r
\r
\f\r
3. Primitive Data Types\r
\r
Atomic components such as integers and characters that are interpretable \r
directly by the CPU are specified in one format for all processors. \r
We chose a format that's most convenient for the Motorola MC68000 \r
processor [M68000 16/32-Bit Microprocessor Programmer's Reference \r
Manual].\r
\r
N.B.: Part 3 dictates the format for "primitive" data types where and \r
only where used in the overall file structure and standard kinds of \r
chunks (Cf. Chunks). The number of such occurrences will be small \r
enough that the costs of conversion, storage, and management of processor-\r
specific files would far exceed the costs of conversion during I/O by "foreign" \r
programs. A particular data chunk may be specified with a different \r
format for its internal primitive types or with processor- or environment-\r
speci fic variants if necessary to optimize local usage. Since that hurts \r
data interchange, it's not recommended. (Cf. Designing New Data Sections, \r
in Part 4.)\r
\r
Alignment\r
\r
All data objects larger than a byte are aligned on even byte addresses \r
relative to the start of the file. This may require padding. Pad bytes \r
are to be written as zeros, but don't count on that when reading.\r
\r
This means that every odd-length "chunk" (see below) must be padded \r
so that the next one will fall on an even boundary. Also, designers \r
of structures to be stored in chunks should include pad fields where \r
needed to align every field larger than a byte. Zeros should be stored \r
in all the pad bytes.\r
\r
Justification: Even-alignment causes a little extra work for files \r
that are used only on certain processors but allows 68000 programs \r
to construct and scan the data in memory and do block I/O. You just \r
add an occasional pad field to data structures that you're going to \r
block read/write or else stream read/write an extra byte. And the \r
same source code works on all processors. Unspecified alignment, on \r
the other hand, would force 68000 programs to (dis)assemble word and \r
long-word data one byte at a time. Pretty cumbersome in a high level \r
language. And if you don't conditionally compile that out for other \r
processors, you won't gain anything.\r
\r
Numbers\r
\r
Numeric types supported are two's complement binary integers in the \r
format used by the MC68000 processor high byte first, high word first the \r
reverse of 8088 and 6502 format. They could potentially include signed \r
and unsigned 8, 16, and 32 bit integers but the standard only uses \r
the following:\r
\r
UBYTE    8 bits unsigned\r
WORD    16 bits signed\r
UWORD   16 bits unsigned\r
LONG    32 bits signed\r
\r
The actual type definitions depend on the CPU and the compiler. In \r
this document, we'll express data type definitions in the C programming \r
language. [See C, A Reference Manual.] In 68000 Lattice C:\r
\r
typedef unsigned char   UBYTE;  /*  8 bits unsigned     */\r
typedef short   WORD;   /* 16 bits signed       */\r
typedef unsigned short  UWORD;  /* 16 bits unsigned     */\r
typedef long    LONG;   /* 32 bits signed       */\r
\r
Characters\r
\r
The following character set is assumed wherever characters are used, \r
e.g. in text strings, IDs, and TEXT chunks (see below).\r
\r
Characters are encoded in 8-bit ASCII. Characters in the range NUL \r
(hex 0) through DEL (hex 7F) are well defined by the 7-bit ASCII standard. \r
IFF uses the graphic group RJS (SP, hex 20) through R~S (hex 7E).\r
\r
Most of the control character group hex 01 through hex 1F have no \r
standard meaning in IFF. The control character LF (hex 0A) is defined \r
as a "newline" character. It denotes an intentional line break, that \r
is, a paragraph or line terminator. (There is no way to store an automatic \r
line break. That is strictly a function of the margins in the environment \r
the text is placed.) The control character ESC (hex 1B) is a reserved \r
escape character under the rules of ANSI standard 3.64-1979 American \r
National Standard Additional Control Codes for Use with ASCII, ISO \r
standard 2022, and ISO/DIS standard 6429.2.\r
\r
Characters in the range hex 7F through hex FF are not globally defined \r
in IFF. They are best left reserved for future standardization. But \r
note that the FORM type FTXT (formatted text) defines the meaning \r
of these characters within FTXT forms. In particular, character values \r
hex 7F through hex 9F are control codes while characters hex A0 through \r
hex FF are extended graphic characters like  , as per the ISO and \r
ANSI standards cited above. [See the supplementary document "FTXT" \r
IFF Formatted Text.]\r
\r
Dates\r
\r
A "creation date" is defined as the date and time a stream of data \r
bytes was created. (Some systems call this a "last modified date".) \r
Editing some data changes its creation date. Moving the data between \r
volumes or machines does not.\r
\r
The IFF standard date format will be one of those used in MS-DOS, \r
Macintosh, or Amiga DOS (probably a 32-bit unsigned number of seconds \r
since a reference point). Issue: Investigate these three.\r
\r
Type IDs\r
\r
A "type ID", "property name", "FORM type", or any other IFF identifier \r
is a 32-bit value: the concatenation of four ASCII characters in the \r
range R S (SP, hex 20) through R~S (hex 7E). Spaces (hex 20) should \r
not precede printing characters; trailing spaces are ok. Control characters \r
are forbidden.\r
\r
typedef CHAR ID[4];\r
\r
IDs are compared using a simple 32-bit case-dependent equality test.\r
\r
Data section type IDs (aka FORM types) are restriced IDs. (Cf. Data \r
Sections.) Since they may be stored in filename extensions (Cf. Single \r
Purpose Files) lower case letters and punctuation marks are forbidden. \r
Trailing spaces are ok.\r
\r
Carefully choose those four characters when you pick a new ID. Make \r
them mnemonic so programmers can look at an interchange format file \r
and figure out what kind of data it contains. The name space makes \r
it possible for developers scattered around the globe to generate \r
ID values with minimal collisions so long as they choose specific \r
names like "MUS4" instead of general ones like "TYPE" and "FILE". \r
EA will "register" new FORM type IDs and format descriptions as they're \r
devised, but collisions will be improbable so there will be no pressure \r
on this "clearinghouse" process. Appendix A has a list of currently \r
defined IDs.\r
\r
Sometimes it's necessary to make data format changes that aren't backward \r
compatible. Since IDs are used to denote data formats in IFF, new \r
IDs are chosen to denote revised formats. Since programs won't read \r
chunks whose IDs they don't recognize (see Chunks, below), the new \r
IDs keep old programs from stumbling over new data. The conventional \r
way to chose a "revision" ID is to increment the last character if \r
it's a digit or else change the last character to a digit. E.g. first \r
and second revisions of the ID "XY" would be "XY1" and "XY2". Revisions \r
of "CMAP" would be "CMA1" and "CMA2".\r
\r
Chunks\r
\r
Chunks are the building blocks in the IFF structure. The form expressed \r
as a C typedef is:\r
\r
typedef struct {\r
        ID      ckID;\r
        LONG    ckSize; /* sizeof(ckData) */\r
        UBYTE   ckData[/* ckSize */];\r
        } Chunk;\r
\r
We can diagram an example chunk a "CMAP" chunk containing 12 data \r
bytes like this:\r
                        ----------------\r
                ckID:   |    'CMAP'    |\r
                ckSize: |      12      |\r
                ckData: | 0, 0, 0, 32  |   -------- \r
                        | 0, 0, 64, 0  |    12 bytes\r
                        | 0, 0, 64, 0  |   ---------\r
                        ----------------\r
\r
The fixed header part means "Here's a type ckID chunk with ckSize \r
bytes of data."\r
\r
The ckID identifies the format and purpose of the chunk. As a rule, \r
a program must recognize ckID to interpret ckData. It should skip \r
over all unrecognized chunks. The ckID also serves as a format version \r
number as long as we pick new IDs to identify new formats of ckData \r
(see above).\r
\r
The following ckIDs are universally reserved to identify chunks with \r
particular IFF meanings: "LIST", "FORM", "PROP", "CAT ", and "    \r
". The special ID "    " (4 spaces) is a ckID for "filler" chunks, \r
that is, chunks that fill space but have no meaningful contents. The \r
IDs "LIS1" through "LIS9", "FOR1" through "FOR9", and "CAT1" through \r
"CAT9" are reserved for future "version number" variations. All IFF-compatible \r
software must account for these 23 chunk IDs. Appendix A has a list \r
of predefined IDs.\r
\r
The ckSize is a logical block size how many data bytes are in ckData. \r
If ckData is an odd number of bytes long, a 0 pad byte follows which \r
is not included in ckSize. (Cf. Alignment.) A chunk's total physical \r
size is ckSize rounded up to an even number plus the size of the header. \r
So the smallest chunk is 8 bytes long with ckSize = 0. For the sake \r
of following chunks, programs must respect every chunk's ckSize as \r
a virtual end-of-file for reading its ckData even if that data is \r
malformed, e.g. if nested contents are truncated.\r
\r
We can describe the syntax of a chunk as a regular expression with \r
"#" representing the ckSize, i.e. the length of the following {braced} \r
bytes. The "[0]" represents a sometimes needed pad byte. (The regular \r
expressions in this document are collected in Appendix A along with \r
an explanation of notation.)\r
\r
Chunk   ::= ID #{ UBYTE* } [0]\r
\r
One chunk output technique is to stream write a chunk header, stream \r
write the chunk contents, then random access back to the header to \r
fill in the size. Another technique is to make a preliminary pass \r
over the data to compute the size, then write it out all at once.\r
\r
Strings, String Chunks, and String Properties\r
\r
In a string of ASCII text, LF denotes a forced line break (paragraph \r
or line terminator). Other control characters are not used. (Cf. Characters.)\r
\r
The ckID for a chunk that contains a string of plain, unformatted \r
text is "TEXT". As a practical matter, a text string should probably \r
not be longer than 32767 bytes. The standard allows up to 231 - 1 \r
bytes.\r
\r
When used as a data property (see below), a text string chunk may \r
be 0 to 255 characters long. Such a string is readily converted to \r
a C string or a Pascal STRING[255]. The ckID of a property must be \r
the property name, not "TEXT".\r
\r
When used as a part of a chunk or data property, restricted C string \r
format is normally used. That means 0 to 255 characters followed by \r
a NUL byte (ASCII value 0).\r
\r
Data Properties\r
\r
Data properties specify attributes for following (non-property) chunks. \r
A data property essentially says "identifier = value", for example \r
"XY = (10, 200)", telling something about following chunks. Properties \r
may only appear inside data sections ("FORM" chunks, cf. Data Sections) \r
and property sections ("PROP" chunks, cf. Group PROP).\r
\r
The form of a data property is a special case of Chunk. The ckID is \r
a property name as well as a property type. The ckSize should be small \r
since data properties are intended to be accumulated in RAM when reading \r
a file. (256 bytes is a reasonable upper bound.) Syntactically:\r
\r
Property::= Chunk\r
\r
When designing a data object, use properties to describe context information \r
like the size of an image, even if they don't vary in your program. \r
Other programs will need this information.\r
\r
Think of property settings as assignments to variables in a programming \r
language. Multiple assignments are redundant and local assignments \r
temporarily override global assignments. The order of assignments \r
doesn't matter as long as they precede the affected chunks. (Cf. LISTs, \r
CATs, and Shared Properties.)\r
\r
Each object type (FORM type) is a local name space for property IDs. \r
Think of a "CMAP" property in a "FORM ILBM" as the qualified ID "ILBM.CMAP". \r
Property IDs specified when an object type is designed (and therefore \r
known to all clients) are called "standard" while specialized ones \r
added later are "nonstandard".\r
\r
Links\r
\r
Issue: A standard mechanism for "links" or "cross references" is very \r
desirable for things like combining images and sounds into animations. \r
Perhaps we'll define "link" chunks within FORMs that refer to other \r
FORMs or to specific chunks within the same and other FORMs. This \r
needs further work. EA IFF 1985 has no standard link mechanism.\r
\r
For now, it may suffice to read a list of, say, musical instruments, \r
and then just refer to them within a musical score by index number.\r
\r
File References\r
\r
Issue: We may need a standard form for references to other files. \r
A "file ref" could name a directory and a file in the same type of \r
operating system as the ref's originator. Following the reference \r
would expect the file to be on some mounted volume. In a network environment, \r
a file ref could name a server, too.\r
\r
Issue: How can we express operating-system independent file refs?\r
\r
Issue: What about a means to reference a portion of another file? \r
Would this be a "file ref" plus a reference to a "link" within the \r
target file?\r
\r
\r
\f\r
4. Data Sections\r
\r
The first thing we need of a file is to check: Does it contain IFF \r
data and, if so, does it contain the kind of data we're looking for? \r
So we come to the notion of a "data section".\r
\r
A "data section" or IFF "FORM" is one self-contained "data object" \r
that might be stored in a file by itself. It is one high level data \r
object such as a picture or a sound effect. The IFF structure "FORM" \r
makes it self- identifying. It could be a composite object like a \r
musical score with nested musical instrument descriptions.\r
\r
Group FORM\r
\r
A data section is a chunk with ckID "FORM" and this arrangement:\r
\r
FORM    ::= "FORM" #{ FormType (LocalChunk | FORM | LIST | CAT)* \r
}\r
FormType::= ID\r
LocalChunk      ::= Property | Chunk\r
\r
The ID "FORM" is a syntactic keyword like "struct" in C. Think of \r
a "struct ILBM" containing a field "CMAP". If you see "FORM" you'll \r
know to expect a FORM type ID (the structure name, "ILBM" in this \r
example) and a particular contents arrangement or "syntax" (local \r
chunks, FORMs, LISTs, and CATs). (LISTs and CATs are discussed in \r
part 5, below.) A "FORM ILBM", in particular, might contain a local \r
chunk "CMAP", an "ILBM.CMAP" (to use a qualified name).\r
\r
So the chunk ID "FORM" indicates a data section. It implies that the \r
chunk contains an ID and some number of nested chunks. In reading \r
a FORM, like any other chunk, programs must respect its ckSize as \r
a virtual end-of-file for reading its contents, even if they're truncated.\r
\r
The FormType (or FORM type) is a restricted ID that may not contain \r
lower case letters or punctuation characters. (Cf. Type IDs. Cf. Single \r
Purpose Files.)\r
\r
The type-specific information in a FORM is composed of its "local \r
chunks": data properties and other chunks. Each FORM type is a local \r
name space for local chunk IDs. So "CMAP" local chunks in other FORM \r
types may be unrelated to "ILBM.CMAP". More than that, each FORM type \r
defines semantic scope. If you know what a FORM ILBM is, you'll know \r
what an ILBM.CMAP is.\r
\r
Local chunks defined when the FORM type is designed (and therefore \r
known to all clients of this type) are called "standard" while specialized \r
ones added later are "nonstandard".\r
\r
Among the local chunks, property chunks give settings for various \r
details like text font while the other chunks supply the essential \r
information. This distinction is not clear cut. A property setting \r
cancelled by a later setting of the same property has effect only \r
on data chunks in between. E.g. in the sequence:\r
\r
prop1 = x  (propN = value)*  prop1 = y\r
\r
where the propNs are not prop1, the setting prop1 = x has no effect.\r
\r
The following universal chunk IDs are reserved inside any FORM: "LIST", \r
"FORM", "PROP", "CAT ", "JJJJ", "LIS1" through "LIS9", "FOR1" through \r
"FOR9", and "CAT1" through "CAT9". (Cf. Chunks. Cf. Group LIST. Cf. \r
Group PROP.) For clarity, these universal chunk names may not be FORM \r
type IDs, either.\r
\r
Part 5, below, talks about grouping FORMs into LISTs and CATs. They \r
let you group a bunch of FORMs but don't impose any particular meaning \r
or constraints on the grouping. Read on.\r
\r
Composite FORMs\r
\r
A FORM chunk inside a FORM is a full-fledged data section. This means \r
you can build a composite object like a multi-frame animation sequence \r
from available picture FORMs and sound effect FORMs. You can insert \r
additional chunks with information like frame rate and frame count.\r
\r
Using composite FORMs, you leverage on existing programs that create \r
and edit the component FORMs. Those editors may even look into your \r
composite object to copy out its type of component, although it'll \r
be the rare program that's fancy enough to do that. Such editors are \r
not allowed to replace their component objects within your composite \r
object. That's because the IFF standard lets you specify consistency \r
requirements for the composite FORM such as maintaining a count or \r
a directory of the components. Only programs that are written to uphold \r
the rules of your FORM type should create or modify such FORMs.\r
\r
Therefore, in designing a program that creates composite objects, \r
you are strongly requested to provide a facility for your users to \r
import and export the nested FORMs. Import and export could move the \r
data through a clipboard or a file.\r
\r
Here are several existing FORM types and rules for defining new ones.\r
\r
FTXT\r
\r
An FTXT data section contains text with character formatting information \r
like fonts and faces. It has no paragraph or document formatting information \r
like margins and page headers. FORM FTXT is well matched to the text \r
representation in Amiga's Intuition environment. See the supplemental \r
document "FTXT" IFF Formatted Text.\r
\r
ILBM\r
\r
"ILBM" is an InterLeaved BitMap image with color map; a machine-independent \r
format for raster images. FORM ILBM is the standard image file format \r
for the Commodore-Amiga computer and is useful in other environments, \r
too. See the supplemental document "ILBM" IFF Interleaved Bitmap.\r
\r
PICS\r
\r
The data chunk inside a "PICS" data section has ID "PICT" and holds \r
a QuickDraw picture. Issue: Allow more than one PICT in a PICS? See \r
Inside Macintosh chapter "QuickDraw" for details on PICTs and how \r
to create and display them on the Macintosh computer.\r
\r
The only standard property for PICS is "XY", an optional property \r
that indicates the position of the PICT relative to "the big picture". \r
The contents of an XY is a QuickDraw Point.\r
\r
Note: PICT may be limited to Macintosh use, in which case there'll \r
be another format for structured graphics in other environments.\r
\r
Other Macintosh Resource Types\r
\r
Some other Macintosh resource types could be adopted for use within \r
IFF files; perhaps MWRT, ICN, ICN#, and STR#.\r
\r
Issue: Consider the candidates and reserve some more IDs.\r
\r
Designing New Data Sections\r
\r
Supplemental documents will define additional object types. A supplement \r
needs to specify the object's purpose, its FORM type ID, the IDs and \r
formats of standard local chunks, and rules for generating and interpreting \r
the data. It's a good idea to supply typedefs and an example source \r
program that accesses the new object. See "ILBM" IFF Interleaved Bitmap \r
for a good example.\r
\r
Anyone can pick a new FORM type ID but should reserve it with Electronic \r
Arts at their earliest convenience. [Issue: EA contact person? Hand \r
this off to another organization?] While decentralized format definitions \r
and extensions are possible in IFF, our preference is to get design \r
consensus by committee, implement a program to read and write it, \r
perhaps tune the format, and then publish the format with example \r
code. Some organization should remain in charge of answering questions \r
and coordinating extensions to the format.\r
\r
If it becomes necessary to revise the design of some data section, \r
its FORM type ID will serve as a version number (Cf. Type IDs). E.g. \r
a revised "VDEO" data section could be called "VDE1". But try to get \r
by with compatible revisions within the existing FORM type.\r
\r
In a new FORM type, the rules for primitive data types and word-alignment \r
(Cf. Primitive Data Types) may be overriden for the contents of its \r
local chunks but not for the chunk structure itself if your documentation \r
spells out the deviations. If machine-specific type variants are needed, \r
e.g. to store vast numbers of integers in reverse bit order, then \r
outline the conversion algorithm and indicate the variant inside each \r
file, perhaps via different FORM types. Needless to say, variations \r
should be minimized.\r
\r
In designing a FORM type, encapsulate all the data that other programs \r
will need to interpret your files. E.g. a raster graphics image should \r
specify the image size even if your program always uses 320 x 200 \r
pixels x 3 bitplanes. Receiving programs are then empowered to append \r
or clip the image rectangle, to add or drop bitplanes, etc. This enables \r
a lot more compatibility.\r
\r
Separate the central data (like musical notes) from more specialized \r
information (like note beams) so simpler programs can extract the \r
central parts during read-in. Leave room for expansion so other programs \r
can squeeze in new kinds of information (like lyrics). And remember \r
to keep the property chunks manageably short let's say 2 256 bytes.\r
\r
When designing a data object, try to strike a good tradeoff between \r
a super-general format and a highly-specialized one. Fit the details \r
to at least one particular need, for example a raster image might \r
as well store pixels in the current machine's scan order. But add \r
the kind of generality that makes it usable with foreseeable hardware \r
and software. E.g. use a whole byte for each red, green, and blue \r
color value even if this year's computer has only 4-bit video DACs. \r
Think ahead and help other programs so long as the overhead is acceptable. \r
E.g. run compress a raster by scan line rather than as a unit so future \r
programs can swap images by scan line to and from secondary storage.\r
\r
Try to design a general purpose "least common multiple" format that \r
encompasses the needs of many programs without getting too complicated. \r
Let's coalesce our uses around a few such formats widely separated \r
in the vast design space. Two factors make this flexibility and simplicity \r
practical. First, file storage space is getting very plentiful, so \r
compaction is not a priority. Second, nearly any locally-performed \r
data conversion work during file reading and writing will be cheap \r
compared to the I/O time.\r
\r
It must be ok to copy a LIST or FORM or CAT intact, e.g. to incorporate \r
it into a composite FORM. So any kind of internal references within \r
a FORM must be relative references. They could be relative to the \r
start of the containing FORM, relative from the referencing chunk, \r
or a sequence number into a collection.\r
\r
With composite FORMs, you leverage on existing programs that create \r
and edit the components. If you write a program that creates composite \r
objects, please provide a facility for your users to import and export \r
the nested FORMs. The import and export functions may move data through \r
a separate file or a clipboard.\r
\r
Finally, don't forget to specify all implied rules in detail.\r
\r
\r
\f\r
5. LISTs, CATs, and Shared Properties\r
\r
Data often needs to be grouped together like a list of icons. Sometimes \r
a trick like arranging little images into a big raster works, but \r
generally they'll need to be structured as a first class group. The \r
objects "LIST" and "CAT" are IFF-universal mechanisms for this purpose.\r
\r
Property settings sometimes need to be shared over a list of similar \r
objects. E.g. a list of icons may share one color map. LIST provides \r
a means called "PROP" to do this. One purpose of a LIST is to define \r
the scope of a PROP. A "CAT", on the other hand, is simply a concatenation \r
of objects.\r
\r
Simpler programs may skip LISTs and PROPs altogether and just handle \r
FORMs and CATs. All "fully-conforming" IFF programs also know about \r
"CAT ", "LIST", and "PROP". Any program that reads a FORM inside a \r
LIST must process shared PROPs to correctly interpret that FORM.\r
\r
Group CAT\r
\r
A CAT is just an untyped group of data objects.\r
\r
Structurally, a CAT is a chunk with chunk ID "CAT " containing a "contents \r
type" ID followed by the nested objects. The ckSize of each contained \r
chunk is essentially a relative pointer to the next one.\r
\r
CAT     ::= "CAT " #{ ContentsType (FORM | LIST | CAT)* }\r
ContentsType    ::= ID  -- a hint or an "abstract data type" ID\r
\r
In reading a CAT, like any other chunk, programs must respect it's \r
ckSize as a virtual end-of-file for reading the nested objects even \r
if they're malformed or truncated.\r
\r
The "contents type" following the CAT's ckSize indicates what kind \r
of FORMs are inside. So a CAT of ILBMs would store "ILBM" there. It's \r
just a hint. It may be used to store an "abstract data type". A CAT \r
could just have blank contents ID ("JJJJ") if it contains more than \r
one kind of FORM.\r
\r
CAT defines only the format of the group. The group's meaning is open \r
to interpretation. This is like a list in LISP: the structure of cells \r
is predefined but the meaning of the contents as, say, an association \r
list depends on use. If you need a group with an enforced meaning \r
(an "abstract data type" or Smalltalk "subclass"), some consistency \r
constraints, or additional data chunks, use a composite FORM instead \r
(Cf. Composite FORMs).\r
\r
Since a CAT just means a concatenation of objects, CATs are rarely \r
nested. Programs should really merge CATs rather than nest them.\r
\r
Group LIST\r
\r
A LIST defines a group very much like CAT but it also gives a scope \r
for PROPs (see below). And unlike CATs, LISTs should not be merged \r
without understanding their contents.\r
\r
Structurally, a LIST is a chunk with ckID "LIST" containing a "contents \r
type" ID, optional shared properties, and the nested contents (FORMs, \r
LISTs, and CATs), in that order. The ckSize of each contained chunk \r
is a relative pointer to the next one. A LIST is not an arbitrary \r
linked list the cells are simply concatenated.\r
\r
LIST    ::= "LIST" #{ ContentsType PROP* (FORM | LIST | CAT)* }\r
ContentsType    ::= ID\r
\r
Group PROP\r
\r
PROP chunks may appear in LISTs (not in FORMs or CATs). They supply \r
shared properties for the FORMs in that LIST. This ability to elevate \r
some property settings to shared status for a list of forms is useful \r
for both indirection and compaction. E.g. a list of images with the \r
same size and colors can share one "size" property and one "color \r
map" property. Individual FORMs can override the shared settings.\r
\r
The contents of a PROP is like a FORM with no data chunks:\r
\r
PROP    ::= "PROP" #{ FormType Property* }\r
\r
It means, "Here are the shared properties for FORM type <<FormType>."\r
\r
A LIST may have at most one PROP of a FORM type, and all the PROPs \r
must appear before any of the FORMs or nested LISTs and CATs. You \r
can have subsequences of FORMs sharing properties by making each subsequence \r
a LIST.\r
\r
Scoping: Think of property settings as variable bindings in nested \r
blocks of a programming language. Where in C you could write:\r
\r
TEXT_FONT text_font = Courier;  /* program's global default     */\r
\r
File(); {\r
        TEXT_FONT text_font = TimesRoman;       /* shared setting       */\r
\r
                {\r
                TEXT_FONT text_font = Helvetica;  /* local setting      */\r
                Print("Hello ");/* uses font Helvetica  */\r
                }\r
\r
                {\r
                Print("there.");/* uses font TimesRoman */\r
                }\r
        }\r
\r
An IFF file could contain:\r
\r
LIST {\r
        PROP TEXT {\r
                FONT {TimesRoman}       /* shared setting       */\r
                }\r
\r
        FORM TEXT {\r
                FONT {Helvetica}/* local setting*/\r
                CHRS {Hello }           /* uses font Helvetica  */\r
                }\r
\r
        FORM TEXT {\r
                CHRS {there.}   /* uses font TimesRoman */\r
                }\r
        }\r
\r
The shared property assignments selectively override the reader's \r
global defaults, but only for FORMs within the group. A FORM's own \r
property assignments selectively override the global and group-supplied \r
values. So when reading an IFF file, keep property settings on a stack. \r
They're designed to be small enough to hold in main memory.\r
\r
Shared properties are semantically equivalent to copying those properties \r
into each of the nested FORMs right after their FORM type IDs.\r
\r
Properties for LIST\r
\r
Optional "properties for LIST" store the origin of the list's contents \r
in a PROP chunk for the fake FORM type "LIST". They are the properties \r
originating program "OPGM", processor family "OCPU", computer type \r
"OCMP", computer serial number or network address "OSN ", and user \r
name "UNAM". In our imperfect world, these could be called upon to \r
distinguish between unintended variations of a data format or to work \r
around bugs in particular originating/receiving program pairs. Issue: \r
Specify the format of these properties.\r
\r
A creation date could also be stored in a property but let's ask that \r
file creating, editing, and transporting programs maintain the correct \r
date in the local file system. Programs that move files between machine \r
types are expected to copy across the creation dates.\r
\r
\r
\f\r
6. Standard File Structure\r
\r
File Structure Overview\r
\r
An IFF file is just a single chunk of type FORM, LIST, or CAT. Therefore \r
an IFF file can be recognized by its first 4 bytes: "FORM", "LIST", \r
or "CAT ". Any file contents after the chunk's end are to be ignored.\r
\r
Since an IFF file can be a group of objects, programs that read/write \r
single objects can communicate to an extent with programs that read/write \r
groups. You're encouraged to write programs that handle all the objects \r
in a LIST or CAT. A graphics editor, for example, could process a \r
list of pictures as a multiple page document, one page at a time.\r
\r
Programs should enforce IFF's syntactic rules when reading and writing \r
files. This ensures robust data transfer. The public domain IFF reader/writer \r
subroutine package does this for you. A utility program "IFFCheck" \r
is available that scans an IFF file and checks it for conformance \r
to IFF's syntactic rules. IFFCheck also prints an outline of the chunks \r
in the file, showing the ckID and ckSize of each. This is quite handy \r
when building IFF programs. Example programs are also available to \r
show details of reading and writing IFF files.\r
\r
A merge program "IFFJoin" will be available that logically appends \r
IFF files into a single CAT group. It "unwraps" each input file that \r
is a CAT so that the combined file isn't nested CATs.\r
\r
If we need to revise the IFF standard, the three anchoring IDs will \r
be used as "version numbers". That's why IDs "FOR1" through "FOR9", \r
"LIS1" through "LIS9", and "CAT1" through "CAT9" are reserved.\r
\r
IFF formats are designed for reasonable performance with floppy disks. \r
We achieve considerable simplicity in the formats and programs by \r
relying on the host file system rather than defining universal grouping \r
structures like directories for LIST contents. On huge storage systems, \r
IFF files could be leaf nodes in a file structure like a B-tree. Let's \r
hope the host file system implements that for us!\r
\r
Thre are two kinds of IFF files: single purpose files and scrap files. \r
They differ in the interpretation of multiple data objects and in \r
the file's external type.\r
\r
Single Purpose Files\r
\r
A single purpose IFF file is for normal "document" and "archive" storage. \r
This is in contrast with "scrap files" (see below) and temporary backing \r
storage (non-interchange files).\r
\r
The external file type (or filename extension, depending on the host \r
file system) indicates the file's contents. It's generally the FORM \r
type of the data contained, hence the restrictions on FORM type IDs.\r
\r
Programmers and users may pick an "intended use" type as the filename \r
extension to make it easy to filter for the relevant files in a filename \r
requestor. This is actually a "subclass" or "subtype" that conveniently \r
separates files of the same FORM type that have different uses. Programs \r
cannot demand conformity to its expected subtypes without overly restricting \r
data interchange since they cannot know about the subtypes to be used \r
by future programs that users will want to exchange data with.\r
\r
Issue: How to generate 3-letter MS-DOS extensions from 4-letter FORM \r
type IDs?\r
\r
Most single purpose files will be a single FORM (perhaps a composite \r
FORM like a musical score containing nested FORMs like musical instrument \r
descriptions). If it's a LIST or a CAT, programs should skip over \r
unrecognized objects to read the recognized ones or the first recognized \r
one. Then a program that can read a single purpose file can read something \r
out of a "scrap file", too.\r
\r
Scrap Files\r
\r
A "scrap file" is for maximum interconnectivity in getting data between \r
programs; the core of a clipboard function. Scrap files may have type \r
"IFF " or filename extension ".IFF".\r
\r
A scrap file is typically a CAT containing alternate representations \r
of the same basic information. Include as many alternatives as you \r
can readily generate. This redundancy improves interconnectivity in \r
situations where we can't make all programs read and write super-general \r
formats. [Inside Macintosh chapter "Scrap Manager".] E.g. a graphically-\r
annotated musical score might be supplemented by a stripped down 4-voice \r
melody and by a text (the lyrics).\r
\r
The originating program should write the alternate representations \r
in order of "preference": most preferred (most comprehensive) type \r
to least preferred (least comprehensive) type. A receiving program \r
should either use the first appearing type that it understands or \r
search for its own "preferred" type.\r
\r
A scrap file should have at most one alternative of any type. (A LIST \r
of same type objects is ok as one of the alternatives.) But don't \r
count on this when reading; ignore extra sections of a type. Then \r
a program that reads scrap files can read something out of single \r
purpose files.\r
\r
Rules for Reader Programs\r
\r
Here are some notes on building programs that read IFF files. If you \r
use the standard IFF reader module "IFFR.C", many of these rules and \r
details will be automatically handled. (See "Support Software" in \r
Appendix A.) We recommend that you start from the example program \r
"ShowILBM.C". You should also read up on recursive descent parsers. \r
[See, for example, Compiler Construction, An Advanced Course.]\r
\r
%       The standard is very flexible so many programs can exchange \r
data. This implies a program has to scan the file and react to what's \r
actually there in whatever order it appears. An IFF reader program \r
is a parser.\r
\r
%       For interchange to really work, programs must be willing to \r
do some conversion during read-in. If the data isn't exactly what \r
you expect, say, the raster is smaller than those created by your \r
program, then adjust it. Similarly, your program could crop a large \r
picture, add or drop bitplanes, and create/discard a mask plane. The \r
program should give up gracefully on data that it can't convert.\r
\r
%       If it doesn't start with "FORM", "LIST", or "CAT ", it's not \r
an IFF-85 file.\r
\r
%       For any chunk you encounter, you must recognize its type ID \r
to understand its contents.\r
\r
%       For any FORM chunk you encounter, you must recognize its FORM \r
type ID to understand the contained "local chunks". Even if you don't \r
recognize the FORM type, you can still scan it for nested FORMs, LISTs, \r
and CATs of interest.\r
\r
%       Don't forget to skip the pad byte after every odd-length chunk.\r
\r
%       Chunk types LIST, FORM, PROP, and CAT are generic groups. They \r
always contain a subtype ID followed by chunks.\r
\r
%       Readers ought to handle a CAT of FORMs in a file. You may treat \r
the FORMs like document pages to sequence through or just use the \r
first FORM.\r
\r
%       Simpler IFF readers completely skip LISTs. "Fully IFF-conforming" \r
readers are those that handle LISTs, even if just to read the first \r
FORM from a file. If you do look into a LIST, you must process shared \r
properties (in PROP chunks) properly. The idea is to get the correct \r
data or none at all.\r
\r
%       The nicest readers are willing to look into unrecognized FORMs \r
for nested FORM types that they do recognize. For example, a musical \r
score may contain nested instrument descriptions and an animation \r
file may contain still pictures.\r
\r
Note to programmers: Processing PROP chunks is not simple! You'll \r
need some background in interpreters with stack frames. If this is \r
foreign to you, build programs that read/write only one FORM per file. \r
For the more intrepid programmers, the next paragraph summarizes how \r
to process LISTs and PROPs. See the general IFF reader module "IFFR.C" \r
and the example program "ShowILBM.C" for details.\r
\r
Allocate a stack frame for every LIST and FORM you encounter and initialize \r
it by copying the stack frame of the parent LIST or FORM. At the top \r
level, you'll need a stack frame initialized to your program's global \r
defaults. While reading each LIST or FORM, store all encountered properties \r
into the current stack frame. In the example ShowILBM, each stack \r
frame has a place for a bitmap header property ILBM.BMHD and a color \r
map property ILBM.CMAP. When you finally get to the ILBM's BODY chunk, \r
use the property settings accumulated in the current stack frame.\r
\r
An alternate implementation would just remember PROPs encountered, \r
forgetting each on reaching the end of its scope (the end of the containing \r
LIST). When a FORM XXXX is encountered, scan the chunks in all remembered \r
PROPs XXXX, in order, as if they appeared before the chunks actually \r
in the FORM XXXX. This gets trickier if you read FORMs inside of FORMs.\r
\r
Rules for Writer Programs\r
\r
Here are some notes on building programs that write IFF files, which \r
is much easier than reading them. If you use the standard IFF writer \r
module "IFFW.C" (see "Support Software" in Appendix A), many of these \r
rules and details will automatically be enforced. See the example \r
program "Raw2ILBM.C".\r
\r
%       An IFF file is a single FORM, LIST, or CAT chunk.\r
\r
%       Any IFF-85 file must start with the 4 characters "FORM", "LIST", \r
or "CAT ", followed by a LONG ckSize. There should be no data after \r
the chunk end.\r
\r
%       Chunk types LIST, FORM, PROP, and CAT are generic. They always \r
contain a subtype ID followed by chunks. These three IDs are universally \r
reserved, as are "LIS1" through "LIS9", "FOR1" through "FOR9", "CAT1" \r
through "CAT9", and "    ".\r
\r
%       Don't forget to write a 0 pad byte after each odd-length chunk.\r
\r
%       Four techniques for writing an IFF group: (1) build the data \r
in a file mapped into virtual memory, (2) build the data in memory \r
blocks and use block I/O, (3) stream write the data piecemeal and \r
(don't forget!) random access back to set the group length count, \r
and (4) make a preliminary pass to compute the length count then stream \r
write the data.\r
\r
%       Do not try to edit a file that you don't know how to create. \r
Programs may look into a file and copy out nested FORMs of types that \r
they recognize, but don't edit and replace the nested FORMs and don't \r
add or remove them. That could make the containing structure inconsistent. \r
You may write a new file containing items you copied (or copied and \r
modified) from another IFF file, but don't copy structural parts you \r
don't understand.\r
\r
%       You must adhere to the syntax descriptions in Appendex A. E.g. \r
PROPs may only appear inside LISTs.\r
\r
\r
\r
\f\r
Appendix A. Reference\r
\r
Type Definitions\r
\r
The following C typedefs describe standard IFF structures. Declarations \r
to use in practice will vary with the CPU and compiler. For example, \r
68000 Lattice C produces efficient comparison code if we define ID \r
as a "LONG". A macro "MakeID" builds these IDs at compile time.\r
\r
/* Standard IFF types, expressed in 68000 Lattice C.    */\r
\r
typedef unsigned char UBYTE;    /*  8 bits unsigned     */\r
typedef short WORD;     /* 16 bits signed       */\r
typedef unsigned short UWORD;   /* 16 bits unsigned     */\r
typedef long LONG;      /* 32 bits signed       */\r
\r
typedef char ID[4];     /* 4 chars in ' ' through '~'   */\r
\r
typedef struct {\r
        ID      ckID;\r
        LONG    ckSize; /* sizeof(ckData)       */\r
        UBYTE   ckData[/* ckSize */];\r
        } Chunk;\r
\r
/* ID typedef and builder for 68000 Lattice C. */\r
typedef LONG ID;        /* 4 chars in ' ' through '~'   */\r
#define MakeID(a,b,c,d) ( (a)<<<<24 | (b)<<<<16 | (c)<<<<8 | (d) )\r
\r
/* Globally reserved IDs. */\r
#define ID_FORM   MakeID('F','O','R','M')\r
#define ID_LIST   MakeID('L','I','S','T')\r
#define ID_PROP   MakeID('P','R','O','P')\r
#define ID_CAT    MakeID('C','A','T',' ')\r
#define ID_FILLER MakeID(' ',' ',' ',' ')\r
\r
Syntax Definitions\r
\r
Here's a collection of the syntax definitions in this document.\r
\r
Chunk   ::= ID #{ UBYTE* } [0]\r
\r
Property::= Chunk\r
\r
FORM    ::= "FORM" #{ FormType (LocalChunk | FORM | LIST | CAT)* \r
}\r
FormType::= ID\r
LocalChunk      ::= Property | Chunk\r
\r
CAT     ::= "CAT " #{ ContentsType (FORM | LIST | CAT)* }\r
ContentsType    ::= ID  -- a hint or an "abstract data type" ID\r
\r
LIST    ::= "LIST" #{ ContentsType PROP* (FORM | LIST | CAT)* }\r
PROP    ::= "PROP" #{ FormType Property* }\r
\r
In this extended regular expression notation, the token "#" represents \r
a ckSize LONG count of the following {braced} data bytes. Literal \r
items are shown in "quotes", [square bracketed items] are optional, \r
and "*" means 0 or more instances. A sometimes-needed pad byte is \r
shown as "[0]".\r
\r
Defined Chunk IDs\r
\r
This is a table of currently defined chunk IDs. We may also borrow \r
some Macintosh IDs and data formats.\r
\r
Group chunk IDs\r
        FORM, LIST, PROP, CAT.\r
Future revision group chunk IDs\r
        FOR1 I FOR9, LIS1 I LIS9, CAT1 I CAT9.\r
FORM type IDs\r
        (The above group chunk IDs may not be used for FORM type IDs.)\r
        (Lower case letters and punctuation marks are forbidden in FORM \r
type IDs.)\r
        8SVX 8-bit sampled sound voice, ANBM animated bitmap, FNTR raster \r
font, FNTV vector font, FTXT formatted text, GSCR general-use musical \r
score, ILBM interleaved raster bitmap image, PDEF Deluxe Print page \r
definition, PICS Macintosh picture, PLBM (obsolete), USCR Uhuru Sound \r
Software musical score, UVOX Uhuru Sound Software Macintosh voice, \r
SMUS simple musical score, VDEO Deluxe Video Construction Set video.\r
Data chunk IDs\r
        "JJJJ", TEXT, PICT.\r
PROP LIST property IDs\r
        OPGM, OCPU, OCMP, OSN, UNAM.\r
\r
\r
\f\r
Support Software\r
\r
These public domain C source programs are available for use in building \r
IFF-compatible programs:\r
\r
IFF.H, IFFR.C, IFFW.C   \r
\r
                IFF reader and writer package. \r
                These modules handle many of the details of reliably \r
                reading and writing IFF files.\r
\r
IFFCheck.C      This handy utility program scans an IFF file, checks \r
                that the contents are well formed, and prints an outline \r
                of the chunks.\r
\r
PACKER.H, Packer.C, UnPacker.C  \r
\r
                Run encoder and decoder used for ILBM files.\r
\r
ILBM.H, ILBMR.C, ILBMW.C\r
\r
                Reader and writer support routines for raster image \r
                FORM ILBM. ILBMR calls IFFR and UnPacker. ILBMW calls \r
                IFFW and Packer.\r
\r
ShowILBM.C      \r
                Example caller of IFFR and ILBMR modules. This \r
                Commodore-Amiga program reads and displays a FORM ILBM.\r
Raw2ILBM.C      \r
                Example ILBM writer program. As a demonstration, it \r
                reads a raw raster image file and writes the image \r
                as a FORM ILBM file.\r
ILBM2Raw.C      \r
                Example ILBM reader program.  Reads a FORM ILBM file\r
                and writes it into a raw raster image.\r
\r
REMALLOC.H, Remalloc.c\r
\r
                Memory allocation routines used in these examples.\r
\r
INTUALL.H       generic "include almost everything" include-file\r
                with the sequence of includes correctly specified.\r
\r
READPICT.H, ReadPict.c  \r
\r
                given an ILBM file, read it into a bitmap and \r
                a color map\r
\r
PUTPICT.H, PutPict.c    \r
\r
                given a bitmap and a color map, save it as\r
                an ILBM file.\r
\r
GIO.H, Gio.c    generic I/O speedup package.  Attempts to speed\r
                disk I/O by buffering writes and reads.\r
\r
giocall.c       sample call to gio.\r
\r
ilbmdump.c      reads in ILBM file, prints out ascii representation\r
                for including in C files.\r
\r
bmprintc.c      prints out a C-language representation of data for\r
                a bitmap.\r
\r
\r
\f\r
Example Diagrams\r
\r
Here's a box diagram for an example IFF file, a raster image FORM \r
ILBM. This FORM contains a bitmap header property chunk BMHD, a color \r
map property chunk CMAP, and a raster data chunk BODY. This particular \r
raster is 320 x 200 pixels x 3 bit planes uncompressed. The "0" after \r
the CMAP chunk represents a zero pad byte; included since the CMAP \r
chunk has an odd length. The text to the right of the diagram shows \r
the outline that would be printed by the IFFCheck utility program \r
for this particular file.\r
\r
        +-----------------------------------+\r
        |'FORM'         24070               |   FORM 24070 IBLM\r
        +-----------------------------------+\r
        |'ILBM'                             |\r
        +-----------------------------------+\r
        | +-------------------------------+ |\r
        | | 'BMHD'      20                | |   .BMHD  20\r
        | | 320, 200, 0, 0, 3, 0, 0, ...  | |\r
        | + ------------------------------+ |\r
        | | 'CMAP'      21                | |   .CMAP  21\r
        | | 0, 0, 0; 32, 0, 0; 64,0,0; .. | |\r
        | +-------------------------------+ |\r
        | 0                                 |\r
        +-----------------------------------+\r
        |'BODY'         24000               |   .BODY 24000\r
        |0, 0, 0, ...                       |\r
        +-----------------------------------+\r
\r
This second diagram shows a LIST of two FORMs ILBM sharing a common \r
BMHD property and a common CMAP property. Again, the text on the right \r
is an outline  a la IFFCheck.\r
\r
\r
     +-----------------------------------------+\r
     |'LIST'            48114                  |  LIST  48114  AAAA\r
     +-----------------------------------------+\r
     |'AAAA'                                   |  .PROP  62  ILBM\r
     |  +-----------------------------------+  |\r
     |  |'PROP'         62                  |  |  \r
     |  +-----------------------------------+  |\r
     |  |'ILBM'                             |  |\r
     |  +-----------------------------------+  |\r
     |  | +-------------------------------+ |  |\r
     |  | | 'BMHD'      20                | |  |  ..BMHD  20\r
     |  | | 320, 200, 0, 0, 3, 0, 0, ...  | |  |\r
     |  | | ------------------------------+ |  |\r
     |  | | 'CMAP'      21                | |  |  ..CMAP  21\r
     |  | | 0, 0, 0; 32, 0, 0; 64,0,0; .. | |  |\r
     |  | +-------------------------------+ |  |\r
     |  | 0                                 |  |\r
     |  +-----------------------------------+  |\r
     |  +-----------------------------------+  |\r
     |  |'FORM'         24012               |  |  .FORM  24012  ILBM\r
     |  +-----------------------------------+  |\r
     |  |'ILBM'                             |  |  \r
     |  +-----------------------------------+  |\r
     |  |  +-----------------------------+  |  |\r
     |  |  |'BODY'              24000    |  |  |  ..BODY  24000\r
     |  |  |0, 0, 0, ...         |  |  |\r
     |  |  +-----------------------------+  |  |\r
     |  +-----------------------------------+  |\r
     |  +-----------------------------------+  |\r
     |  |'FORM'         24012               |  |  .FORM  24012  ILBM\r
     |  +-----------------------------------+  |\r
     |  |'ILBM'                             |  |\r
     |  +-----------------------------------+  |\r
     |  |  +-----------------------------+  |  |\r
     |  |  |'BODY'              24000    |  |  |  ..BODY  24000\r
     |  |  |0, 0, 0, ...         |  |  |\r
     |  |  +-----------------------------+  |  |\r
     |  +-----------------------------------+  |\r
     +-----------------------------------------+\r
\r
\r
\f\r
Appendix B. Standards Committee\r
\r
The following people contributed to the design of this IFF standard:\r
\r
Bob "Kodiak" Burns, Commodore-Amiga\r
R. J. Mical, Commodore-Amiga\r
Jerry Morrison, Electronic Arts\r
Greg Riker, Electronic Arts\r
Steve Shaw, Electronic Arts\r
Barry Walsh, Commodore-Amiga\r