Apple Icon Image

The Apple Icon Image format (.icns) is an icon format used in Apple Inc.'s macOS. It supports icons of 16 × 16, 32 × 32, 48 × 48, 128 × 128, 256 × 256, 512 × 512 points at 1x and 2x scale, with both 1- and 8-bit alpha channels and multiple image states (example: open and closed folders). The fixed-size icons can be scaled by the operating system and displayed at any intermediate size.

As of macOS 11, asset catalogs are the preferred file format for macOS custom icons.

File structure

The file format consists of an 8 byte header, followed by any number of icons.

Header

Icon data

Icon types

* The value inside the parenthesis is the uncompressed length for ARGB and 24-bit RGB icons.
* data always starts with a header of four zero-bytes (tested all icns files in macOS 10.15.7 and macOS 11). Usage unknown, the four zero-bytes can be any value and are quietly ignored.
* These formats are supported in standalone icns files but do not display properly if used as application icon inside a package.

Image data format

* Mono icons with alpha mask can display three colors: white, black, and transparent.
* The 4-bit an 8-bit icons use a fixed color palette with 16 colors and 256 colors, respectively.
* The 24-bit RGB format consists of the three compressed channels tightly packed (see Compression). The icon must start with a four-byte header, see footnote above.
* The ARGB format consists of the ascii values for 'ARGB' and the four compressed channels tightly packed (see Compression).

Compatibility

* the ARGB fields also accept files in PNG format – but not vice versa, you can not put ARGB images in any of the PNG-only fields (tested on macOS 11).
* ARGB images are only supported in macOS 11 and newer – macOS 10.15.7 does not display ARGB images. Yet, even the ARGB keys can be displayed on macOS 10.15 if you set a JPEG 2000 or PNG image (see footnote on usage in app packages above).
* The 24-bit RGB icons (, , , ) also allow images in JPEG 2000 and PNG format (tested on macOS 10.15.7 and macOS 11).
* The support for newer image types seems to be introduced later than the key field (see previous two points). Therefore, the supported OS version may not be accurate or adjusted based on file format.

Other types

* The table of contents is a list of all contained types (4 byte type-name + 4 byte length).
* The data for all nested icns files does not contain the icns file-header. So, if you want to save the data to a file you have to prepend the icns header.

Non-PNG / JPEG2000 Element Types

Element types that deal with ARGB (32-bit) or RGB (24-bit) image formats require different types of headers before the binary data. It is important to note that this header is part of the image data and is not the 4-byte big endian icon element type value (e.g. ic04 or ic05).

ARGB Elements
ARGB images must have their binary portion of the image data preceded by the four byte 'ARGB' header. After that, instead of each pixel with each of its four channels stored together (e.g. ARGBARGBARGB), an image with three pixels would be stored in individual channels of pixel data (e.g. AAARRRGGGBBB). In addition, each channel of pixel data needs to be encoded as mentioned below.

RGB Elements
RGB images have their binary portion of the image data preceded by four zero byte characters only when the element type is 'it32'. In all other cases, no header is needed. Channel data is separated as with the ARGB binary data (e.g. RRRGGGBBB instead of RGBRGBRGB). Each channel must also be encoded as mentioned below.

Mask Elements
Mask elements are not encoded like ARGB and RGB image color channel data. The data is the same as that of an ARGB image except only the alpha channel data is provided. So for an image that has two pixels, ARGBARGB, the mask data is AA.

Compression

Over time the format has been improved and there is support for compression of some parts of the pixel data. The 24-bit RGB (, , , , , ) and ARGB (, , ) pixel data are compressed (per channel) with a format similar to PackBits.Macintosh Icons
/ref>
Some sources mention that the OS supports both compressed or uncompressed data chunks. However, manually crafting icns files with uncompressed 24-bit RGB or ARGB images will not display properly – at least on newer macOS releases (tested on macOS 11).

Here is a GitHub repo with some swift code that appears to pass the test for both encoding and decoding as described here
ByteRunLengthCoder

The following pseudocode decompresses the data:

Example: should decompress to

The following pseudocode compresses the data:

Example: should compress to

Known issues

As of macOS 11, there are certain issues / bugs with the file format:

# Setting or will display a proper icon. But setting ignores the transparency mask and displays an icon without transparency.
# Compressed ARGB data is not interpreted correctly. The last value of the blue channel (aka. the very last value) is ignored and treated as if it were all zero-bytes. Usually this is no issue since most icons will have transparency at the bottom right corner anyway. However, it can become an issue if the last value is a repeating byte (see Compression). Potentially, up to 130 pixels can lack the blue channel value.
A workaround is to append an additional byte at the end which is interpreted as a control character without following data. You can compare the difference with these two examples:
#*
#*
# macOS 10.15.7 (likely earlier) and later versions have an issue displaying PNG and JPEG 2000 icons for the keys (16x16), (32x32), and (64x64). The keys work fine in a standalone icns file but if used in an application, the icons are displayed completely scrambled. Either use the new ARGB format and (macOS 11+) or the old 24-bit RGB + alpha mask format. Use the latter with the old keys and , or with the newer keys and (writing RGB data into PNG fields). If using ARGB image data, make sure to provide alternative formats for macOS 10.15 and earlier. This issue is especially tricky to detect if you provide both, 16x16 and 16x16@2x icons, because if you connect your Mac to a non-retina monitor, the non-retina 16x16 icon will be used and thus the icon will be displayed scrambled. The field does not seem to be used in application icons and can safely be ignored. Additionally, if you don't provide the smaller icon sizes at all the bug will also manifest when the OS scales down your larger PNG/JPEG 2000 icons, so make sure to render smaller sizes and include them.

Support

Various apps can open *.icns files including Preview and GTK+, with some offering the ability to convert *.icns to and from PNG as well. Former tools specializing in icon file support include Icon Composer and icns Browser from Apple, IconBuilder from The Iconfactory, and CandyBar from Panic.

MacOS offers the built-in iconutil command line tool to pack and unpack *.icns files.

See also

* ICO format on Windows
* X PixMap format for X11

References

External links

IconFamily
(last update 2013) – Open source Objective C class to read and write Apple icns files

osxiconutils
(not maintained) – Command line tools to work with Apple icns files

icnsutil
– Python library to read and write icns files

icns
- Rust crate to read and write icns files

createicns
- C library to read and write icns files

icon_records_extractor
- C library to extract all icns records as their own icons include dark mode icns.

{{Graphics file formats

Graphics file formats
MacOS
Computer icons