heif  3.6.1
About: HEIF (High Efficiency Image File Format) is a visual media container format for images and image sequences (MPEG-standard). This HEIF engine demonstrates its powerful features and capabilities (under Nokia HEIF license).
  Fossies Dox: heif-3.6.1.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

heif Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. heif-3.6.1.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).

High Efficiency Image File Format (HEIF)

HEIF is a visual media container format standardized by the Moving Picture Experts Group (MPEG) for storage and sharing of images and image sequences. It is based on the well-known ISO Base Media File Format (ISOBMFF) standard. HEIF Reader/Writer Engine is an implementation of HEIF standard in order to demonstrate its powerful features and capabilities.

Please follow this link to access HEIF Web-Site. You can also check the Wiki pages for more information.

For MIAF specific code, please switch to the MIAF branch.


[25.06.2020] v3.6.0 Release: Added support for several new properties, image items with decoding dependencies, Extended type box and Type combination box, associating properties for entity groups, and reader support for segmented tracks. Minor improvements and code cleanup.

[10.07.2019] v3.5.0 Release: Improved support for JPEGs and edit lists. Bug fixes, minor improvements and code cleanup.

[06.11.2018] v3.4.0 Release: Java API improvements. Bug fixes, code cleanup and robustness improvements.

[13.06.2018] v3.3.0 Release: Java desktop build added, Java API includes track and image sequence as well as entity grouping support.

[06.04.2018] v3.2 Release. Two new APIs added, a Java API which wraps the C++ libraries using JNI and a convenience C++ API (which is used by the Java API) that wraps the underlying reader and writer. The Java API is expected to remain relatively stable, however the new C++ API will most likely change in the future.

[14.03.2018] v3.1 Release. Reader API update, bug fixes and examples update.

[05.03.2018] Code updated and tagged v3.0. Writer executable replaced with writer library / API. Implementation is based on HEIF standard specification ISO/IEC 23008-12:2017 that is available from iso.org web pages.

[09.03.2017] ISO/IEC 23008-12 second edition includes support for the interchange of multi-layered images. The source code now includes structures that are specified in this second edition. Simple support for AVC is also added. Minor bug fixes are included in this update. Example configuration files for generating multi-layered streams can be found in the Wiki.

[24.02.2016] HEIF source code and website is updated to reflect the latest HEIF specification changes and various fixes. Please note that backwards compatibility is not maintained during this update.

[24.02.2016] HEIF conformance test candidate files can be found here


HEIF is a media container format. It is not an image or video encoder per se. Hence, the quality of the visual media depends highly on the proper usage of visual media encoder (e.g. HEVC). Current standard allows containing HEVC/AVC/JPEG encoded bitstreams. This can be easily extended to future visual media codecs. It has many powerful features which are currently not present in other image file formats. Some of these features are:

  • Encapsulate images coded using HEVC/SHVC/MV-HEVC/AVC/JPEG.
  • Encapsulate image sequences coded using HEVC/SHVC/MV-HEVC/AVC.
  • Storage based on widely adopted ISO Base Media File Format (ISOBMFF)
  • Supports efficient storage of image bursts and cinemagraphs
  • Supports computational photography use cases
  • Supports both lossy and lossless image data storage
  • A better and easy way to distribute still images, image collections and related metadata.

Please follow this link to see HEIF file examples.

Contents of the Repository:

This repository contains the following items:

  • ISO Base Media File Format (ISOBMFF) box parse/write source code (under srcs/common/)
  • HEIF Reader API and Library (under srcs/api/reader/)
  • HEIF Writer API and Library (under srcs/api/writer/)
  • HEIF Reader/Writer Java API (under srcs/api-java/)
  • HEIF Reader/Writer convenience C++ API (under srcs/api-cpp/)
  • HEIF Reader API Usage Example Code (under srcs/examples/)
  • HEIF Source Code Documentation (Doxygen generator under docs/)
  • HEIF Web Site Content (in **gh-pages branch**)
  • HEIF Reader JavaScript Implementation (in **gh-pages branch**)

Building source:

Prerequisites: cmake and compiler supporting C++11 in PATH.

cd heif/build
cmake --help
cmake ../srcs -G"<Generator listed by above command for your target platform>"
cmake --build .

Building Java API for Windows or Linux

Prerequisites: Java version 8 or newer, Gradle.

First build the C/C++ library as described above.

After that

cd heif/build/java-desktop
gradle build

Note that in order to run the Java API you need to have the HEIF JNI library built in the earlier step (heifjni.dll or heifjni.so) in the Java library search path.

Building Java API for Android:

Prerequisites: Android SDK & NDK Import the project files under heif/build/android into Android Studio and build the library

See wiki page for more information and platform specific instructions.


Please see LICENSE.TXT file for the terms of use of the contents of this repository.

All the example media files (*.heic, *.png, *.jpg, *.gif) in this repository are under copyright © Nokia Technologies 2015-2018.

For more information/questions/source code/commercial licensing related issues, please contact: heif@nokia.com

All rights reserved.