APNG Specification

From MozillaWiki
Revision as of 19:04, 21 March 2007 by Pavlov (talk | contribs) (APNG 0.9)

Jump to: navigation, search

APNG 0.9 [DRAFT]

Authors:

  • Stuart Parmenter <pavlov@pavlov.net>
  • Vladimir Vukicevic <vladimir@pobox.com>
  • Andrew Smith <asmith15@learn.senecac.on.ca>

Big Important Note

We are currently waiting on the PNG group to approve our use of our chunks as public chunks (i.e. 2nd letter is capitalized.) Once they have approved the chunk names only the public chunk names will be valid and APNGs created before that point will become invalid.

acTL -> aCTL, fcTL -> fCTL, fdAT -> fDAT

Overview

APNG is an extension of the [PNG][pngspec] format, adding support for animated images. It is intended to be a replacement for simple animated images that have traditionally used the [GIF][gifspec] format, while adding support for 24-bit images and 8-bit transparency. APNG is a simpler alternative to MNG, providing a spec suitable for the most common usage of animated images on the Internet.

APNG is backwards-compatible with PNG; any PNG decoder should be able to decode the first frame of an APNG and treat it as a normal single-frame PNG.

Structure

An APNG stream is a normal PNG stream as defined in the [PNG Specification][pngspec], with three additional chunk types describing the animation and providing additional frame data. The first frame of an animation, frame 0, is encoded as a normal PNG. This frame is what decoders that do not understand the APNG chunks will display.

The size of the first frame defines the boundaries of the entire animation; hence, if extra space will be needed for later frames that is unused in the first frame, the first frame should be appropriately padded with fully transparent regions.

To be recognized as an APNG, an `acTL` chunk must appear in the stream before any `IDAT` chunks. The `acTL` structure is described in the next section.

An `fcTL` chunk must also appear before `IDAT`, providing frame information for the first frame encoded in the PNG stream's `IDAT` chunks, known as frame 0. If there is no fCTl chunk before IDAT, then frame 0 is intialized to RGBA(0,0,0,0) and the IDAT chunks are not used.

Subsequent frames are encoded in `fdAT` chunks containing almost the same structure of content as IDAT chunks. Information for each frame about placement and rendering is stored in `fcTL` chunks. The full layout of `fdAT` and `fcTL` chunks is described below.

Note: For purposes of chunk descriptions, an "unsigned int" shall be a 32-bit unsigned integer in network byte order limited to the range 0 to (2^31)-1; an "unsigned short" shall be a 16-bit unsigned integer in network byte order; a "byte" shall be an 8-bit unsigned integer.

Terminology

The "canvas" is the area on the output device on which the images are to be written. The contents of the canvas are not available to the decoder.

The "output buffer" is a pixel array with dimensions specified by the width and height parameters of the PNG IHDR chunk. Conceptually, the images are constructed in the output buffer and then written to the canvas. The contents of the output buffer are available to the decoder. The corner pixels of the output buffer are mapped to the corners of the canvas.

Chunk Sequence Numbers

The `fcTL` and `fdAT` chunks have a 4 byte sequence number. Both chunk types share the sequence. The purpose of this number is to detect (and optionally correct) sequence errors in an Animated PNG, since the PNG specification does not impose orderng restrictions on ancillary chunks.

The first fCTl chunk must contain sequence number 0, and the sequence numbers in the remaining fCTl and fDAt chunks must be in order, with no gaps or duplicates.

The table below illustrates the use of sequence numbers for images with more than one frame and more than one `fdAT` chunk:

    Sequence number    Chunk
    0                  `fcTL` describing frame 0
    1                  `fcTL` describing frame 1
    2                  first `fdAT` for frame 1
    3                  second `fdAT` for frame 1
    ....

or, when frame 0 is implicitly a transparent black frame:

    Sequence number    Chunk
    0                  fCTl describing frame 1
    1                  first fDAt for frame 1
    2                  second fDAt for frame 1
    ....

APNG viewers must abandon the APNG chunks in a datastream with out-of-order APNG chunks and display frame 0 instead. APNG-aware PNG editors should restore them to correct order using the sequence numbers.

`acTL`: The Animation Control Chunk

The `acTL` chunk is an ancillary chunk as defined in the PNG Specification. It must appear before the first `IDAT` chunk within a valid PNG stream.

The `acTL` chunk contains:

    byte
     0   num_frames     (unsigned int)    Number of frames
     4   num_iterations (unsigned int)    Number of times to loop this APNG.  0 indicates infinite looping.

`num_frames` indicates the total number of frames in the animation. 0 is not a valid value. 1 is a valid value for a single-frame APNG. In case this number does not match the actual number of frames, behaviour of the implementation is not specified.

`num_iterations` indicates the number of iterations that this animation should play; if it is 0, the animation should play indefinitely. If nonzero, the animation should come to rest on the final non-skipped frame at the end of the last iteration.

`fcTL`: The Frame Control Chunk

The `fcTL` chunk is an ancillary chunk as defined in the PNG Specification. It must appear before the `IDAT` or `fdAT` chunks of the frame to which it applies, specifically:

  • For the first frame, the `fcTL` chunk must appear before the first `IDAT` chunk. Position relative to the `acTL` chunk is not specified.
  • For the second frame, the `fcTL` chunk must appear after the `IDAT` chunks from the first frame and before the fdAT chunks for the second frame.
  • For any subsequent frames, the `fcTL` chunk for the frame N must appear after the `fdAT` chunks from the frame N-1 and before the fdAT chunks for the frame N.
  • Other ancillary chunks are allowed to appear among the APNG chunks, including between fDAt chunks. Decoders must ignore such chunks.

The fCTl chunk is mandatory for every frame except for frame 0. When it is present for frame 0, decoders must render frame 0 from the data in the IDAT chunks. When it is not present for frame 0, frame 0 is a transparent black frame (all pixels are RGBA(0,0,0,0)) and the IDAT chunks are ignored. More than one fCTl chunk per frame is not allowed.

Format:

   byte
    0    sequence_number       (unsigned int)   Sequence number of the animation chunk, starting from 0
    4    width                 (unsigned int)   Width of the following frame
    8    height                (unsigned int)   Height of the following frame
   12    x_offset              (unsigned int)   X position at which to render the following frame
   16    y_offset              (unsigned int)   Y position at which to render the following frame
   20    delay_num             (unsigned short) Frame delay fraction numerator
   22    delay_den             (unsigned short) Frame delay fraction denominator
   24    render_op             (byte)           Type of output buffer area disposal to be done after rendering this frame

The frame must be rendered within the region defined by the `width`, `height`, `x_offset` and `y_offset` from the `fcTL`, and the width and height from the `IHDR` chunk.

The width and height must be greater than zero and must not be bigger than (respectively) the width and height specified in the IHDR chunk.

For frame 0 the width and height fields must equal the width and height from the `IHDR` chunk. Also for frame 0 the `x_offset` and `y_offset` fields must be 0. No part of the region may fall outside the area defined by frame 0.

The `delay_num` and `delay_den` parameters together specify a fraction indicating the delay after the current frame, in seconds. If the denominator is 0, it is to be treated as if it were 100 (that is, delay_num then specifies 1/100ths of a second). If the the value of the numerator is 0 the decoder should render the next frame as quickly as possible, though viewers may impose a reasonable lower bound on the delay.

The `render_op` parameter contains flags describing how the frame is to be disposed before rendering the next frame; it also specifies whether the frame is to be alpha blended into the current output buffer content, or whether it should completely replace its region in the output buffer. Valid render_op flags are:

   bit
   +-------------------------------+
   | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
   +-----------------|---|---|---|-+
                     |   +---+---+------ bits 0-2: dispose_op
                     |
                     +------------------ bit 3: APNG_RENDER_OP_BLEND_FLAG


Bits 4 through 7 are reserved and must be 0.

Valid values for `dispose_op` are:

   value  bit
   1      0     APNG_RENDER_OP_DISPOSE_NONE
   2      1     APNG_RENDER_OP_DISPOSE_BACKGROUND
   4      2     APNG_RENDER_OP_DISPOSE_PREVIOUS
  • `APNG_RENDER_OP_DISPOSE_NONE`: no disposal is done on this frame before rendering the next; its contents are left on the output buffer. This is the default.
  • `APNG_RENDER_OP_DISPOSE_BACKGROUND`: the frame's region is to be cleared to the background color. If no `bKGD` chunk is specified, the result is fully transparent black (r, g, b, and a all 0).
  • `APNG_RENDER_OP_DISPOSE_PREVIOUS`: the frame's region is to be reverted to the previous contents.

`APNG_RENDER_OP_BLEND_FLAG` may be added to any of the above disposal operations. If this flag is 0, all color components of the frame, including alpha, overwrite the current contents of the frame's output buffer region. If the APNG_RENDER_OP_BLEND_FLAG is not 0 the frame should be composited onto the output buffer based on its alpha, using a simple OVER operation as described in the "Alpha Channel Processing" section of the PNG specification [pngspec]. Note that Variation 2 of the sample code is applicable.

`APNG_RENDER_OP_BLEND_FLAG` is not valid for color types 0 (greyscale without alpha) or 2 (truecolor without alpha). It is valid for type 3 (indexed) images; however, the resulting pixel values may not be present in the specified palette. It is always valid for type 4 (greyscale with alpha) and type 6 (truecolor with alpha) images.

APNG_RENDER_OP_BLEND_FLAG must be 0 for frame 0.

`fdAT`: The Frame Data Chunk

The `fdAT` chunk has the same purpose as an `IDAT` chunk. It has the same data structure as an `IDAT` chunk, except a sequence number is appended in the beginning.

Each frame must contain at least one fDAt chunk. The compressed datastream is then the concatenation of the contents of the data fields of all the fDAt chunks within a frame. When decompressed, the datastream is a complete PNG image, including the filter byte at the beginning of each scanline. It utilizes the same bit depth, color type, compression method, filter method, interlace method, and palette (if any) as the main image.

Format:

    byte
    0    sequence_number       (unsigned int)   Sequence number of the animation chunk, starting from 0
    4    frame_data            X bytes          Frame data for this frame

Each frame inherits every property except the width and the height specified by any critical or ancillary chunks before the first IDAT in the file.

If the PNG oFFs chunk is present, it supplies offsets of the canvas that are in addition to the frame's "x_offset" and "y_offset".

If the PNG pHYs chunk is present, the APNG images and their "x_offset" and "y_offset" values must be scaled in the same way as the main image. Conceptually, such scaling occurs while mapping the output buffer onto the canvas.

Revisions to this Specification

From 0.1

  • Renamed chunks to `anIm` and `frAm` to comply with chunk naming conventions in the PNG spec.
  • Added a more detailed explanation of APNG structure in Section 2.
  • Added information for png interaction with other chunks in section 3.2.
  • Changed `frAm` chunk offsets and delay into signed integers.

From 0.2

  • Changed `frAm` chunk to `afRa` to avoid conflict with MNG `FRAM` chunk.
  • Changed format: instead of sequences of IHDR..IDAT..IEND, frames other than frame 0 are stored in `afRa` chunks.
  • Added `start_frame` to `anIm` to indicate which frame the animation should start on.
  • Removed `num_frames` from `anIm` chunk

From 0.3

  • Added `aCTL`, `fdAT`, `fcTL` chunk descriptions as per the latest png-list discussion
  • Added section 4, "Interactions with other PNG chunks"; described global and local palettes and

transparency

  • Changed `oFFs` chunk section to refer to more general chunks
  • Updated `aDAT` description to indicate that all frames must either be in a single chunk, or that the first

chunk must have empty data.

  • Added notice that each frame's region (x,y,width,height) must lie completely within the parent PNG canvas
  • Fixed dispose_op description (after, not before)
  • Changed dipose_op to render_op; added disposal description; added BLEND flag
  • Changed delay_time to a delay numerator and denominator, for specifying delays that don't into integer

numbers of milliseconds.

  • Added note to clarify that palette animation is not supported.
  • Removed start_frame from aCTL; require fcTL for frame 0; added SKIP_FRAME fCTL flag.

From 0.4

  • Reintroduced num_frames into aCTL
  • Moved sequence_number from aDAT into fCTL
  • Changed contents of aDAT to fCTL+IDATs+fEND
  • Added clarifications on what's allowed and what isn't
  • Renamed aCTL to acTL, fCTL to fcTL, aDAT to fdAT and fEND to feND to comply with the PNG spec chunk naming requirements

From 0.5

  • Added the IHDR and PLTE CRCs to the acTl chunk
  • The acTL fcTL and adAT are now copy safe, renamed them to acTl, fcTl and adAt

From 0.6

  • The fdAt chunk is no longer a container for other chunks, but rather a replacement for an IDAT chunk
  • Removed the feND chunk
  • Added a sequence number field to fdAt
  • Reintroduced the width and height fields in fcTl

From 0.7

  • Removed 'hidden' flag, instead only the first frame can be hidden and it is signaled with a missing fcTl
  • IDAT, fcTl and fdAt are no longer required to have no other chunks in between them

From 0.8

  • Removed CRCs for IHDR and PLTE from acTl
  • The acTL fcTL and adAT are now not copy safe, renamed them to acTL, fcTL and adAT

Test Encoder and Sample Images

Sample images are available from the APNG implementation page at http://littlesvr.ca/apng/

A. References

[pngspec]: http://www.w3.org/TR/PNG/ "Portable Network Graphics (PNG) Specification (Second Edition)"

[pngext]: http://www.libpng.org/pub/png/spec/register/pngext-1.2.0-pdg.html "Extensions to the PNG Specification, Version 1.2.0"

[gifspec]: http://www.w3.org/Graphics/GIF/spec-gif89a.txt "Graphics Interchange Format 89a"