heif  3.7.0
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.7.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

com.nokia.heif.HEIF Class Reference
Collaboration diagram for com.nokia.heif.HEIF:

Classes

enum  PreloadMode
 

Public Member Functions

 HEIF ()
 
 HEIF (String filename) throws Exception
 
 HEIF (String filename, PreloadMode preloadMode) throws Exception
 
 HEIF (InputStream inputStream) throws Exception
 
void release ()
 
void load (String filename, PreloadMode preloadMode) throws Exception
 
void load (String filename) throws Exception
 
void load (InputStream inputStream, PreloadMode preloadMode) throws Exception
 
void load (InputStream inputStream) throws Exception
 
void save (String filename) throws Exception
 
void save (OutputStream outputStream) throws Exception
 
List< ItemgetItems () throws Exception
 
List< ImageItemgetImages () throws Exception
 
List< ImageItemgetMasterImages () throws Exception
 
List< ItemgetItemsOfType (FourCC typeFourCC) throws Exception
 
ImageItem getPrimaryImage () throws Exception
 
void setPrimaryImage (ImageItem primaryImage) throws Exception
 
List< FourCCgetCompatibleBrands () throws Exception
 
void addCompatibleBrand (FourCC brand) throws Exception
 
void removeCompatibleBrand (FourCC brand) throws Exception
 
FourCC getMajorBrand () throws Exception
 
void setMajorBrand (FourCC brand) throws Exception
 
List< ItemPropertygetItemProperties () throws Exception
 
List< EntityGroupgetEntityGroups () throws Exception
 
List< EntityGroupgetEntityGroupsByType (FourCC type) throws Exception
 
List< TrackgetTracks () throws Exception
 
List< AlternativeTrackGroupgetAlternativeTrackGroups () throws Exception
 

Static Public Member Functions

static void registerEntityGroup (Class groupClass, FourCC groupType) throws Exception
 
static void registerItemProperty (Class groupClass, FourCC groupType) throws Exception
 
static void resetEntityGroupClasses ()
 
static void resetItemPropertyClasses ()
 

Static Public Attributes

static final FourCC FOURCC_AVC = new FourCC("avc1", true)
 
static final FourCC FOURCC_HEVC = new FourCC("hvc1", true)
 
static final FourCC FOURCC_JPEG = new FourCC("jpeg", true)
 
static final FourCC FOURCC_IDENTITY = new FourCC("iden", true)
 
static final FourCC FOURCC_OVERLAY = new FourCC("iovl", true)
 
static final FourCC FOURCC_GRID = new FourCC("grid", true)
 
static final FourCC FOURCC_EXIF = new FourCC("Exif", true)
 
static final FourCC FOURCC_AAC = new FourCC("mp4a", true)
 
static final FourCC FOURCC_AUDIO_TRACK = new FourCC("soun", true)
 
static final FourCC FOURCC_VIDEO_TRACK = new FourCC("vide", true)
 
static final FourCC FOURCC_IMAGE_SEQUENCE = new FourCC("pict", true)
 
static final FourCC FOURCC_EQUIVALENCE = new FourCC("eqiv", true)
 
static final FourCC FOURCC_ALTERNATE = new FourCC("altr", true)
 
static final FourCC FOURCC_STEREO_PAIR = new FourCC("ster", true)
 
static final FourCC FOURCC_AUXILIARY_PROPERTY = new FourCC("auxc", true)
 
static final FourCC FOURCC_CLEAN_APERTURE_PROPERTY = new FourCC("clap", true)
 
static final FourCC FOURCC_NCLX_COLOUR_PROPERTY = new FourCC("nclx", true)
 
static final FourCC FOURCC_MIRROR_PROPERTY = new FourCC("imir", true)
 
static final FourCC FOURCC_ROTATE_PROPERTY = new FourCC("irot", true)
 
static final FourCC FOURCC_PIXEL_ASPECT_RATIO_PROPERTY = new FourCC("pasp", true)
 
static final FourCC FOURCC_PIXEL_INFORMATION_RATIO_PROPERTY = new FourCC("pixi", true)
 
static final FourCC FOURCC_RELATIVE_LOCATION_PROPERTY = new FourCC("rloc", true)
 
static final FourCC BRAND_MIF1 = new FourCC("mif1", true)
 
static final FourCC BRAND_HEIC = new FourCC("heic", true)
 
static final FourCC BRAND_HEIX = new FourCC("heix", true)
 
static final FourCC BRAND_HEVC = new FourCC("hevc", true)
 
static final FourCC BRAND_AVCS = new FourCC("avcs", true)
 
static final FourCC BRAND_AVCI = new FourCC("avci", true)
 
static final FourCC BRAND_JPEG = new FourCC("jpeg", true)
 
static final FourCC BRAND_ISO8 = new FourCC("iso8", true)
 
static final FourCC BRAND_MSF1 = new FourCC("msf1", true)
 
static final FourCC BRAND_MP41 = new FourCC("mp41", true)
 

Protected Member Functions

void finalize () throws Throwable
 
Base createItem (String fourCC, long nativeHandle)
 
Base createItemProperty (String fourCC, long nativeHandle)
 
Base createDecoderConfig (String fourCC, long nativeHandle)
 
Base createSample (String fourCC, long nativeHandle)
 
Base createEntityGroup (String fourCC, long nativeHandle)
 
Base createTrack (String fourCC, long nativeHandle)
 

Protected Attributes

long mNativeHandle
 

Private Member Functions

List< EntityGroupgetEntityGroupsPrivate (FourCC type) throws Exception
 
void checkState () throws Exception
 
void checkParameter (Object parameter) throws Exception
 
void checkParameterAllowNull (Object parameter) throws Exception
 
Base createBase (Class clazz, long nativeHandle)
 
native void createInstanceNative ()
 
native void destroyInstanceNative ()
 
native void loadNative (String filename, int preloadMode)
 
native void loadStreamNative (InputStream stream, int preloadMode)
 
native void saveNative (String filename)
 
native void saveStreamNative (OutputStream stream)
 
native int getItemCountNative ()
 
native Item getItemNative (int itemIndex)
 
native int getImageCountNative ()
 
native ImageItem getImageNative (int itemIndex)
 
native int getMasterImageCountNative ()
 
native ImageItem getMasterImageNative (int itemIndex)
 
native int getItemsOfTypeCountNative (String type)
 
native Item getItemOfTypeNative (String type, int itemIndex)
 
native ImageItem getPrimaryItemNative ()
 
native void setPrimaryItemNative (ImageItem item)
 
native String getMajorBrandNative ()
 
native void setMajorBrandNative (String brand)
 
native int getCompatibleBrandsCountNative ()
 
native String getCompatibleBrandNative (int index)
 
native void addCompatibleBrandNative (String brand)
 
native void removeCompatibleBrandNative (String brand)
 
native int getPropertyCountNative ()
 
native ItemProperty getPropertyNative (int index)
 
native int getTrackCountNative ()
 
native Track getTrackNative (int index)
 
native int getAlternativeTrackGroupCountNative ()
 
native AlternativeTrackGroup getAlternativeTrackGroupNative (int index)
 
native int getEntityGroupCountNative ()
 
native EntityGroup getEntityGroupNative (int index)
 

Static Private Member Functions

static void resetItemClasses ()
 
static void resetDecoderConfigClasses ()
 
static void resetSampleClasses ()
 
static void resetTrackClasses ()
 

Static Private Attributes

static final String TAG = "HEIF"
 
static Map< String, Class > ITEM_CLASSES = null
 
static Map< String, Class > ITEM_PROPERTY_CLASSES = null
 
static Map< String, Class > DECODER_CONFIG_CLASSES = null
 
static Map< String, Class > SAMPLE_CLASSES = null
 
static Map< String, Class > ENTITY_GROUP_CLASSES = null
 
static Map< String, Class > TRACK_CLASSES = null
 

Detailed Description

Definition at line 24 of file HEIF.java.

Constructor & Destructor Documentation

◆ HEIF() [1/4]

com.nokia.heif.HEIF.HEIF ( )
inline

Creates a HEIF instance which can be used to read and write HEIF files

Definition at line 89 of file HEIF.java.

References com.nokia.heif.HEIF.createInstanceNative().

Here is the call graph for this function:

◆ HEIF() [2/4]

com.nokia.heif.HEIF.HEIF ( String  filename) throws Exception
inline

Creates a HEIF instance from the given file

Parameters
filenamePath to the file to be opened
Exceptions
ExceptionThrown if the loading fails

Definition at line 99 of file HEIF.java.

References com.nokia.heif.HEIF.load(), and com.nokia.heif.HEIF.release().

Here is the call graph for this function:

◆ HEIF() [3/4]

com.nokia.heif.HEIF.HEIF ( String  filename,
PreloadMode  preloadMode 
) throws Exception
inline

Creates a HEIF instance from the given file

Parameters
filenamePath to the file to be opened
preloadModeIn which mode the file should be loaded
Exceptions
ExceptionThrown if the loading fails

Definition at line 120 of file HEIF.java.

References com.nokia.heif.HEIF.load(), and com.nokia.heif.HEIF.release().

Here is the call graph for this function:

◆ HEIF() [4/4]

com.nokia.heif.HEIF.HEIF ( InputStream  inputStream) throws Exception
inline

Creates a HEIF instance from the given input stream

Parameters
inputStreamInput stream
Exceptions
ExceptionThrown if the loading fails

Definition at line 140 of file HEIF.java.

References com.nokia.heif.HEIF.load(), and com.nokia.heif.HEIF.release().

Here is the call graph for this function:

Member Function Documentation

◆ addCompatibleBrand()

void com.nokia.heif.HEIF.addCompatibleBrand ( FourCC  brand) throws Exception
inline

Adds a compatible brand for the HEIF instance

Parameters
brandThe brand FourCC as a String
Exceptions
Exception

Definition at line 424 of file HEIF.java.

References com.nokia.heif.HEIF.addCompatibleBrandNative(), com.nokia.heif.HEIF.checkParameter(), and com.nokia.heif.HEIF.checkState().

Here is the call graph for this function:

◆ addCompatibleBrandNative()

native void com.nokia.heif.HEIF.addCompatibleBrandNative ( String  brand)
private

Referenced by com.nokia.heif.HEIF.addCompatibleBrand().

Here is the caller graph for this function:

◆ checkParameter()

void com.nokia.heif.HEIF.checkParameter ( Object  parameter) throws Exception
inlineprivate

Definition at line 644 of file HEIF.java.

References com.nokia.heif.Base.getParentHEIF(), com.nokia.heif.ErrorHandler.INVALID_PARAMETER, com.nokia.heif.Base.mNativeHandle, com.nokia.heif.ErrorHandler.OBJECT_ALREADY_DELETED, and com.nokia.heif.ErrorHandler.WRONG_HEIF_INSTANCE.

Referenced by com.nokia.heif.HEIF.addCompatibleBrand(), com.nokia.heif.HEIF.checkParameterAllowNull(), com.nokia.heif.HEIF.getItemsOfType(), com.nokia.heif.HEIF.load(), com.nokia.heif.HEIF.removeCompatibleBrand(), com.nokia.heif.HEIF.save(), and com.nokia.heif.HEIF.setMajorBrand().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkParameterAllowNull()

void com.nokia.heif.HEIF.checkParameterAllowNull ( Object  parameter) throws Exception
inlineprivate

Definition at line 665 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter().

Referenced by com.nokia.heif.HEIF.setPrimaryImage().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkState()

◆ createBase()

Base com.nokia.heif.HEIF.createBase ( Class  clazz,
long  nativeHandle 
)
inlineprivate

Definition at line 691 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.createDecoderConfig(), com.nokia.heif.HEIF.createEntityGroup(), com.nokia.heif.HEIF.createItem(), com.nokia.heif.HEIF.createItemProperty(), com.nokia.heif.HEIF.createSample(), and com.nokia.heif.HEIF.createTrack().

Here is the caller graph for this function:

◆ createDecoderConfig()

Base com.nokia.heif.HEIF.createDecoderConfig ( String  fourCC,
long  nativeHandle 
)
inlineprotected

Definition at line 736 of file HEIF.java.

References com.nokia.heif.HEIF.createBase(), and com.nokia.heif.HEIF.DECODER_CONFIG_CLASSES.

Here is the call graph for this function:

◆ createEntityGroup()

Base com.nokia.heif.HEIF.createEntityGroup ( String  fourCC,
long  nativeHandle 
)
inlineprotected

Definition at line 759 of file HEIF.java.

References com.nokia.heif.HEIF.createBase(), and com.nokia.heif.HEIF.ENTITY_GROUP_CLASSES.

Here is the call graph for this function:

◆ createInstanceNative()

native void com.nokia.heif.HEIF.createInstanceNative ( )
private

Referenced by com.nokia.heif.HEIF.HEIF().

Here is the caller graph for this function:

◆ createItem()

Base com.nokia.heif.HEIF.createItem ( String  fourCC,
long  nativeHandle 
)
inlineprotected

Definition at line 713 of file HEIF.java.

References com.nokia.heif.HEIF.createBase(), and com.nokia.heif.HEIF.ITEM_CLASSES.

Here is the call graph for this function:

◆ createItemProperty()

Base com.nokia.heif.HEIF.createItemProperty ( String  fourCC,
long  nativeHandle 
)
inlineprotected

Definition at line 726 of file HEIF.java.

References com.nokia.heif.HEIF.createBase(), and com.nokia.heif.HEIF.ITEM_PROPERTY_CLASSES.

Here is the call graph for this function:

◆ createSample()

Base com.nokia.heif.HEIF.createSample ( String  fourCC,
long  nativeHandle 
)
inlineprotected

Definition at line 746 of file HEIF.java.

References com.nokia.heif.HEIF.createBase(), and com.nokia.heif.HEIF.SAMPLE_CLASSES.

Here is the call graph for this function:

◆ createTrack()

Base com.nokia.heif.HEIF.createTrack ( String  fourCC,
long  nativeHandle 
)
inlineprotected

Definition at line 769 of file HEIF.java.

References com.nokia.heif.HEIF.createBase(), and com.nokia.heif.HEIF.TRACK_CLASSES.

Here is the call graph for this function:

◆ destroyInstanceNative()

native void com.nokia.heif.HEIF.destroyInstanceNative ( )
private

Referenced by com.nokia.heif.HEIF.finalize(), and com.nokia.heif.HEIF.release().

Here is the caller graph for this function:

◆ finalize()

void com.nokia.heif.HEIF.finalize ( ) throws Throwable
inlineprotected

Definition at line 214 of file HEIF.java.

References com.nokia.heif.HEIF.destroyInstanceNative(), and com.nokia.heif.HEIF.mNativeHandle.

Here is the call graph for this function:

◆ getAlternativeTrackGroupCountNative()

native int com.nokia.heif.HEIF.getAlternativeTrackGroupCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getAlternativeTrackGroups().

Here is the caller graph for this function:

◆ getAlternativeTrackGroupNative()

native AlternativeTrackGroup com.nokia.heif.HEIF.getAlternativeTrackGroupNative ( int  index)
private

Referenced by com.nokia.heif.HEIF.getAlternativeTrackGroups().

Here is the caller graph for this function:

◆ getAlternativeTrackGroups()

List< AlternativeTrackGroup > com.nokia.heif.HEIF.getAlternativeTrackGroups ( ) throws Exception
inline

Returns a list of all the alternative track groups in the HEIF file

Returns
List of all the alternative track groups
Exceptions
Exception

Definition at line 531 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getAlternativeTrackGroupCountNative(), and com.nokia.heif.HEIF.getAlternativeTrackGroupNative().

Here is the call graph for this function:

◆ getCompatibleBrandNative()

native String com.nokia.heif.HEIF.getCompatibleBrandNative ( int  index)
private

Referenced by com.nokia.heif.HEIF.getCompatibleBrands().

Here is the caller graph for this function:

◆ getCompatibleBrands()

List< FourCC > com.nokia.heif.HEIF.getCompatibleBrands ( ) throws Exception
inline

Returns all compatible brands of the HEIF instance.

Returns
List containing the compatible brands as Strings
Exceptions
Exception

Definition at line 406 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getCompatibleBrandNative(), and com.nokia.heif.HEIF.getCompatibleBrandsCountNative().

Here is the call graph for this function:

◆ getCompatibleBrandsCountNative()

native int com.nokia.heif.HEIF.getCompatibleBrandsCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getCompatibleBrands().

Here is the caller graph for this function:

◆ getEntityGroupCountNative()

native int com.nokia.heif.HEIF.getEntityGroupCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getEntityGroupsPrivate().

Here is the caller graph for this function:

◆ getEntityGroupNative()

native EntityGroup com.nokia.heif.HEIF.getEntityGroupNative ( int  index)
private

Referenced by com.nokia.heif.HEIF.getEntityGroupsPrivate().

Here is the caller graph for this function:

◆ getEntityGroups()

List< EntityGroup > com.nokia.heif.HEIF.getEntityGroups ( ) throws Exception
inline

Returns all the EntityGroups in the HEIF instance

Returns
List of all the EntityGroups
Exceptions
Exception

Definition at line 495 of file HEIF.java.

References com.nokia.heif.HEIF.getEntityGroupsPrivate().

Here is the call graph for this function:

◆ getEntityGroupsByType()

List< EntityGroup > com.nokia.heif.HEIF.getEntityGroupsByType ( FourCC  type) throws Exception
inline

Definition at line 502 of file HEIF.java.

References com.nokia.heif.HEIF.getEntityGroupsPrivate().

Here is the call graph for this function:

◆ getEntityGroupsPrivate()

List< EntityGroup > com.nokia.heif.HEIF.getEntityGroupsPrivate ( FourCC  type) throws Exception
inlineprivate

Definition at line 614 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.FourCC.equals(), com.nokia.heif.HEIF.getEntityGroupCountNative(), com.nokia.heif.HEIF.getEntityGroupNative(), and com.nokia.heif.EntityGroup.getType().

Referenced by com.nokia.heif.HEIF.getEntityGroups(), and com.nokia.heif.HEIF.getEntityGroupsByType().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getImageCountNative()

native int com.nokia.heif.HEIF.getImageCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getImages().

Here is the caller graph for this function:

◆ getImageNative()

native ImageItem com.nokia.heif.HEIF.getImageNative ( int  itemIndex)
private

Referenced by com.nokia.heif.HEIF.getImages().

Here is the caller graph for this function:

◆ getImages()

List< ImageItem > com.nokia.heif.HEIF.getImages ( ) throws Exception
inline

Returns all objects of ImageItem type in this HEIF instance

Returns
List of all ImageItems
Exceptions
Exception

Definition at line 322 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getImageCountNative(), and com.nokia.heif.HEIF.getImageNative().

Here is the call graph for this function:

◆ getItemCountNative()

native int com.nokia.heif.HEIF.getItemCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getItems().

Here is the caller graph for this function:

◆ getItemNative()

native Item com.nokia.heif.HEIF.getItemNative ( int  itemIndex)
private

Referenced by com.nokia.heif.HEIF.getItems().

Here is the caller graph for this function:

◆ getItemOfTypeNative()

native Item com.nokia.heif.HEIF.getItemOfTypeNative ( String  type,
int  itemIndex 
)
private

Referenced by com.nokia.heif.HEIF.getItemsOfType().

Here is the caller graph for this function:

◆ getItemProperties()

List< ItemProperty > com.nokia.heif.HEIF.getItemProperties ( ) throws Exception
inline

Returns all the ItemProperties in the HEIF instance

Returns
List of all the ItemProperties
Exceptions
Exception

Definition at line 477 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getPropertyCountNative(), and com.nokia.heif.HEIF.getPropertyNative().

Here is the call graph for this function:

◆ getItems()

List< Item > com.nokia.heif.HEIF.getItems ( ) throws Exception
inline

Returns all objects of Item type in this HEIF instance.

Returns
List of all items
Exceptions
Exception

Definition at line 304 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getItemCountNative(), and com.nokia.heif.HEIF.getItemNative().

Here is the call graph for this function:

◆ getItemsOfType()

List< Item > com.nokia.heif.HEIF.getItemsOfType ( FourCC  typeFourCC) throws Exception
inline

Returns all Items of the given type

Parameters
typeFourCCFourCC code of the wanted type
Returns
List of all Items with the given type
Exceptions
Exception

Definition at line 360 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getItemOfTypeNative(), and com.nokia.heif.HEIF.getItemsOfTypeCountNative().

Here is the call graph for this function:

◆ getItemsOfTypeCountNative()

native int com.nokia.heif.HEIF.getItemsOfTypeCountNative ( String  type)
private

Referenced by com.nokia.heif.HEIF.getItemsOfType().

Here is the caller graph for this function:

◆ getMajorBrand()

FourCC com.nokia.heif.HEIF.getMajorBrand ( ) throws Exception
inline

Returns the major brand of the HEIF instance Every valid HEIF file must have the major brand set

Returns
The brand FourCC as a String
Exceptions
Exception

Definition at line 451 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.getMajorBrandNative().

Here is the call graph for this function:

◆ getMajorBrandNative()

native String com.nokia.heif.HEIF.getMajorBrandNative ( )
private

Referenced by com.nokia.heif.HEIF.getMajorBrand().

Here is the caller graph for this function:

◆ getMasterImageCountNative()

native int com.nokia.heif.HEIF.getMasterImageCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getMasterImages().

Here is the caller graph for this function:

◆ getMasterImageNative()

native ImageItem com.nokia.heif.HEIF.getMasterImageNative ( int  itemIndex)
private

Referenced by com.nokia.heif.HEIF.getMasterImages().

Here is the caller graph for this function:

◆ getMasterImages()

List< ImageItem > com.nokia.heif.HEIF.getMasterImages ( ) throws Exception
inline

Returns all master images of the HEIF instance. Master images are all ImageItems except those that are either thumbnails or auxiliary images.

Returns
List of all master images
Exceptions
Exception

Definition at line 341 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getMasterImageCountNative(), and com.nokia.heif.HEIF.getMasterImageNative().

Here is the call graph for this function:

◆ getPrimaryImage()

ImageItem com.nokia.heif.HEIF.getPrimaryImage ( ) throws Exception
inline

Returns the primary item of the HEIF instance. Every valid HEIF file should have a primary image. The Primary image can be either a coded image or a derived image.

Returns
The Primary image for this HEIF file
Exceptions
Exception

Definition at line 380 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.getPrimaryItemNative().

Here is the call graph for this function:

◆ getPrimaryItemNative()

native ImageItem com.nokia.heif.HEIF.getPrimaryItemNative ( )
private

Referenced by com.nokia.heif.HEIF.getPrimaryImage().

Here is the caller graph for this function:

◆ getPropertyCountNative()

native int com.nokia.heif.HEIF.getPropertyCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getItemProperties().

Here is the caller graph for this function:

◆ getPropertyNative()

native ItemProperty com.nokia.heif.HEIF.getPropertyNative ( int  index)
private

Referenced by com.nokia.heif.HEIF.getItemProperties().

Here is the caller graph for this function:

◆ getTrackCountNative()

native int com.nokia.heif.HEIF.getTrackCountNative ( )
private

Referenced by com.nokia.heif.HEIF.getTracks().

Here is the caller graph for this function:

◆ getTrackNative()

native Track com.nokia.heif.HEIF.getTrackNative ( int  index)
private

Referenced by com.nokia.heif.HEIF.getTracks().

Here is the caller graph for this function:

◆ getTracks()

List< Track > com.nokia.heif.HEIF.getTracks ( ) throws Exception
inline

Returns all the tracks in the HEIF file

Returns
List of the tracks
Exceptions
Exception

Definition at line 513 of file HEIF.java.

References com.nokia.heif.HEIF.checkState(), com.nokia.heif.HEIF.getTrackCountNative(), and com.nokia.heif.HEIF.getTrackNative().

Here is the call graph for this function:

◆ load() [1/4]

void com.nokia.heif.HEIF.load ( InputStream  inputStream) throws Exception
inline

Loads a HEIF file from a stream

Parameters
inputStreamThe input stream for the file
Exceptions
Exception

Definition at line 270 of file HEIF.java.

References com.nokia.heif.HEIF.load(), and com.nokia.heif.HEIF.PreloadMode.LOAD_ALL_DATA.

Here is the call graph for this function:

◆ load() [2/4]

void com.nokia.heif.HEIF.load ( InputStream  inputStream,
PreloadMode  preloadMode 
) throws Exception
inline

Loads a HEIF file from a stream

Parameters
inputStreamThe input stream for the file
preloadModeIn which mode the file should be loaded
Exceptions
Exception

Definition at line 257 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.loadStreamNative().

Here is the call graph for this function:

◆ load() [3/4]

void com.nokia.heif.HEIF.load ( String  filename) throws Exception
inline

Loads a HEIF file. Can be called only once per instance.

Parameters
filenameFilename including the path
Exceptions
Exception

Definition at line 245 of file HEIF.java.

References com.nokia.heif.HEIF.load(), and com.nokia.heif.HEIF.PreloadMode.LOAD_ALL_DATA.

Here is the call graph for this function:

◆ load() [4/4]

void com.nokia.heif.HEIF.load ( String  filename,
PreloadMode  preloadMode 
) throws Exception
inline

Loads a HEIF file. Can be called only once per instance.

Parameters
filenameFilename including the path
preloadModeIn which mode the file should be loaded
Exceptions
Exception

Definition at line 232 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.loadNative().

Referenced by com.nokia.heif.HEIF.HEIF(), and com.nokia.heif.HEIF.load().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ loadNative()

native void com.nokia.heif.HEIF.loadNative ( String  filename,
int  preloadMode 
)
private

Referenced by com.nokia.heif.HEIF.load().

Here is the caller graph for this function:

◆ loadStreamNative()

native void com.nokia.heif.HEIF.loadStreamNative ( InputStream  stream,
int  preloadMode 
)
private

Referenced by com.nokia.heif.HEIF.load().

Here is the caller graph for this function:

◆ registerEntityGroup()

static void com.nokia.heif.HEIF.registerEntityGroup ( Class  groupClass,
FourCC  groupType 
) throws Exception
inlinestatic

Registers a custom entity group type.

Parameters
groupClassThe class of the custom group
groupTypeThe FourCC type of the custom group
Exceptions
Exception

Definition at line 162 of file HEIF.java.

References com.nokia.heif.HEIF.ENTITY_GROUP_CLASSES, com.nokia.heif.ErrorHandler.INCORRECT_SUPERCLASS, and com.nokia.heif.ErrorHandler.TYPE_ALREADY_EXISTS.

◆ registerItemProperty()

static void com.nokia.heif.HEIF.registerItemProperty ( Class  groupClass,
FourCC  groupType 
) throws Exception
inlinestatic

Registers a custom item property type

Parameters
groupClassThe class of the custom property
groupTypeThe FourCC type of the custom property
Exceptions
Exception

Definition at line 188 of file HEIF.java.

References com.nokia.heif.ErrorHandler.INCORRECT_SUPERCLASS, com.nokia.heif.HEIF.ITEM_PROPERTY_CLASSES, and com.nokia.heif.ErrorHandler.TYPE_ALREADY_EXISTS.

◆ release()

void com.nokia.heif.HEIF.release ( )
inline

Releases the resources held by the HEIF instance. This will invalidate every child item of the instance

Definition at line 205 of file HEIF.java.

References com.nokia.heif.HEIF.destroyInstanceNative(), and com.nokia.heif.HEIF.mNativeHandle.

Referenced by com.nokia.heif.HEIF.HEIF().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ removeCompatibleBrand()

void com.nokia.heif.HEIF.removeCompatibleBrand ( FourCC  brand) throws Exception
inline

Removes a compatible brand from the HEIF instance

Parameters
brandThe brand FourCC as a String
Exceptions
Exception

Definition at line 437 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.removeCompatibleBrandNative().

Here is the call graph for this function:

◆ removeCompatibleBrandNative()

native void com.nokia.heif.HEIF.removeCompatibleBrandNative ( String  brand)
private

Referenced by com.nokia.heif.HEIF.removeCompatibleBrand().

Here is the caller graph for this function:

◆ resetDecoderConfigClasses()

static void com.nokia.heif.HEIF.resetDecoderConfigClasses ( )
inlinestaticprivate

Definition at line 588 of file HEIF.java.

References com.nokia.heif.HEIF.DECODER_CONFIG_CLASSES, com.nokia.heif.HEIF.FOURCC_AAC, com.nokia.heif.HEIF.FOURCC_AVC, com.nokia.heif.HEIF.FOURCC_HEVC, com.nokia.heif.HEIF.FOURCC_JPEG, and com.nokia.heif.FourCC.toString().

Here is the call graph for this function:

◆ resetEntityGroupClasses()

static void com.nokia.heif.HEIF.resetEntityGroupClasses ( )
inlinestatic

Resets the entity group class registrations

Definition at line 547 of file HEIF.java.

References com.nokia.heif.HEIF.ENTITY_GROUP_CLASSES, com.nokia.heif.HEIF.FOURCC_ALTERNATE, com.nokia.heif.HEIF.FOURCC_EQUIVALENCE, com.nokia.heif.HEIF.FOURCC_STEREO_PAIR, and com.nokia.heif.FourCC.toString().

Here is the call graph for this function:

◆ resetItemClasses()

static void com.nokia.heif.HEIF.resetItemClasses ( )
inlinestaticprivate

Definition at line 574 of file HEIF.java.

References com.nokia.heif.HEIF.FOURCC_AVC, com.nokia.heif.HEIF.FOURCC_EXIF, com.nokia.heif.HEIF.FOURCC_GRID, com.nokia.heif.HEIF.FOURCC_HEVC, com.nokia.heif.HEIF.FOURCC_IDENTITY, com.nokia.heif.HEIF.FOURCC_JPEG, com.nokia.heif.HEIF.FOURCC_OVERLAY, com.nokia.heif.HEIF.ITEM_CLASSES, and com.nokia.heif.FourCC.toString().

Here is the call graph for this function:

◆ resetItemPropertyClasses()

static void com.nokia.heif.HEIF.resetItemPropertyClasses ( )
inlinestatic

◆ resetSampleClasses()

static void com.nokia.heif.HEIF.resetSampleClasses ( )
inlinestaticprivate

Definition at line 597 of file HEIF.java.

References com.nokia.heif.HEIF.FOURCC_AAC, com.nokia.heif.HEIF.FOURCC_AVC, com.nokia.heif.HEIF.FOURCC_HEVC, com.nokia.heif.HEIF.SAMPLE_CLASSES, and com.nokia.heif.FourCC.toString().

Here is the call graph for this function:

◆ resetTrackClasses()

static void com.nokia.heif.HEIF.resetTrackClasses ( )
inlinestaticprivate

Definition at line 606 of file HEIF.java.

References com.nokia.heif.HEIF.FOURCC_AUDIO_TRACK, com.nokia.heif.HEIF.FOURCC_IMAGE_SEQUENCE, com.nokia.heif.HEIF.FOURCC_VIDEO_TRACK, com.nokia.heif.FourCC.toString(), and com.nokia.heif.HEIF.TRACK_CLASSES.

Here is the call graph for this function:

◆ save() [1/2]

void com.nokia.heif.HEIF.save ( OutputStream  outputStream) throws Exception
inline

Definition at line 291 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.saveStreamNative().

Here is the call graph for this function:

◆ save() [2/2]

void com.nokia.heif.HEIF.save ( String  filename) throws Exception
inline

Saves the HEIF instance to a file. Can be called multiple times with the same instance. Checks are performed to ensure that the file will be a valid HEIF file so the instance should have at least a displayable primary image and a major and compatible brands set.

Parameters
filenameFilename including the path
Exceptions
Exception

Definition at line 283 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.saveNative().

Here is the call graph for this function:

◆ saveNative()

native void com.nokia.heif.HEIF.saveNative ( String  filename)
private

Referenced by com.nokia.heif.HEIF.save().

Here is the caller graph for this function:

◆ saveStreamNative()

native void com.nokia.heif.HEIF.saveStreamNative ( OutputStream  stream)
private

Referenced by com.nokia.heif.HEIF.save().

Here is the caller graph for this function:

◆ setMajorBrand()

void com.nokia.heif.HEIF.setMajorBrand ( FourCC  brand) throws Exception
inline

Sets the major brand for the HEIF instance. Every valid HEIF file must have a major brand so one must be set before saving a HEIF instance to file

Parameters
brandThe brand FourCC as a String
Exceptions
Exception

Definition at line 464 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameter(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.setMajorBrandNative().

Here is the call graph for this function:

◆ setMajorBrandNative()

native void com.nokia.heif.HEIF.setMajorBrandNative ( String  brand)
private

Referenced by com.nokia.heif.HEIF.setMajorBrand().

Here is the caller graph for this function:

◆ setPrimaryImage()

void com.nokia.heif.HEIF.setPrimaryImage ( ImageItem  primaryImage) throws Exception
inline

Sets the primary image for the HEIF instance. Will replace any existing primary image. Old primary image will still remain in the instance as a master image

Parameters
primaryImageThe ImageItem to be set as primary image
Exceptions
Exception

Definition at line 393 of file HEIF.java.

References com.nokia.heif.HEIF.checkParameterAllowNull(), com.nokia.heif.HEIF.checkState(), and com.nokia.heif.HEIF.setPrimaryItemNative().

Here is the call graph for this function:

◆ setPrimaryItemNative()

native void com.nokia.heif.HEIF.setPrimaryItemNative ( ImageItem  item)
private

Referenced by com.nokia.heif.HEIF.setPrimaryImage().

Here is the caller graph for this function:

Member Data Documentation

◆ BRAND_AVCI

final FourCC com.nokia.heif.HEIF.BRAND_AVCI = new FourCC("avci", true)
static

Definition at line 64 of file HEIF.java.

◆ BRAND_AVCS

final FourCC com.nokia.heif.HEIF.BRAND_AVCS = new FourCC("avcs", true)
static

Definition at line 63 of file HEIF.java.

◆ BRAND_HEIC

final FourCC com.nokia.heif.HEIF.BRAND_HEIC = new FourCC("heic", true)
static

Definition at line 60 of file HEIF.java.

◆ BRAND_HEIX

final FourCC com.nokia.heif.HEIF.BRAND_HEIX = new FourCC("heix", true)
static

Definition at line 61 of file HEIF.java.

◆ BRAND_HEVC

final FourCC com.nokia.heif.HEIF.BRAND_HEVC = new FourCC("hevc", true)
static

Definition at line 62 of file HEIF.java.

◆ BRAND_ISO8

final FourCC com.nokia.heif.HEIF.BRAND_ISO8 = new FourCC("iso8", true)
static

Definition at line 66 of file HEIF.java.

◆ BRAND_JPEG

final FourCC com.nokia.heif.HEIF.BRAND_JPEG = new FourCC("jpeg", true)
static

Definition at line 65 of file HEIF.java.

◆ BRAND_MIF1

final FourCC com.nokia.heif.HEIF.BRAND_MIF1 = new FourCC("mif1", true)
static

Definition at line 59 of file HEIF.java.

◆ BRAND_MP41

final FourCC com.nokia.heif.HEIF.BRAND_MP41 = new FourCC("mp41", true)
static

Definition at line 68 of file HEIF.java.

◆ BRAND_MSF1

final FourCC com.nokia.heif.HEIF.BRAND_MSF1 = new FourCC("msf1", true)
static

Definition at line 67 of file HEIF.java.

◆ DECODER_CONFIG_CLASSES

Map<String, Class> com.nokia.heif.HEIF.DECODER_CONFIG_CLASSES = null
staticprivate

◆ ENTITY_GROUP_CLASSES

Map<String, Class> com.nokia.heif.HEIF.ENTITY_GROUP_CLASSES = null
staticprivate

◆ FOURCC_AAC

final FourCC com.nokia.heif.HEIF.FOURCC_AAC = new FourCC("mp4a", true)
static

◆ FOURCC_ALTERNATE

final FourCC com.nokia.heif.HEIF.FOURCC_ALTERNATE = new FourCC("altr", true)
static

Definition at line 48 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetEntityGroupClasses().

◆ FOURCC_AUDIO_TRACK

final FourCC com.nokia.heif.HEIF.FOURCC_AUDIO_TRACK = new FourCC("soun", true)
static

Definition at line 44 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetTrackClasses().

◆ FOURCC_AUXILIARY_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_AUXILIARY_PROPERTY = new FourCC("auxc", true)
static

Definition at line 50 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_AVC

final FourCC com.nokia.heif.HEIF.FOURCC_AVC = new FourCC("avc1", true)
static

◆ FOURCC_CLEAN_APERTURE_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_CLEAN_APERTURE_PROPERTY = new FourCC("clap", true)
static

Definition at line 51 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_EQUIVALENCE

final FourCC com.nokia.heif.HEIF.FOURCC_EQUIVALENCE = new FourCC("eqiv", true)
static

Definition at line 47 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetEntityGroupClasses().

◆ FOURCC_EXIF

final FourCC com.nokia.heif.HEIF.FOURCC_EXIF = new FourCC("Exif", true)
static

Definition at line 40 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemClasses().

◆ FOURCC_GRID

final FourCC com.nokia.heif.HEIF.FOURCC_GRID = new FourCC("grid", true)
static

Definition at line 39 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemClasses().

◆ FOURCC_HEVC

final FourCC com.nokia.heif.HEIF.FOURCC_HEVC = new FourCC("hvc1", true)
static

◆ FOURCC_IDENTITY

final FourCC com.nokia.heif.HEIF.FOURCC_IDENTITY = new FourCC("iden", true)
static

Definition at line 37 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemClasses().

◆ FOURCC_IMAGE_SEQUENCE

final FourCC com.nokia.heif.HEIF.FOURCC_IMAGE_SEQUENCE = new FourCC("pict", true)
static

Definition at line 46 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetTrackClasses().

◆ FOURCC_JPEG

final FourCC com.nokia.heif.HEIF.FOURCC_JPEG = new FourCC("jpeg", true)
static

◆ FOURCC_MIRROR_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_MIRROR_PROPERTY = new FourCC("imir", true)
static

Definition at line 53 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_NCLX_COLOUR_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_NCLX_COLOUR_PROPERTY = new FourCC("nclx", true)
static

Definition at line 52 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_OVERLAY

final FourCC com.nokia.heif.HEIF.FOURCC_OVERLAY = new FourCC("iovl", true)
static

Definition at line 38 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemClasses().

◆ FOURCC_PIXEL_ASPECT_RATIO_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_PIXEL_ASPECT_RATIO_PROPERTY = new FourCC("pasp", true)
static

Definition at line 55 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_PIXEL_INFORMATION_RATIO_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_PIXEL_INFORMATION_RATIO_PROPERTY = new FourCC("pixi", true)
static

Definition at line 56 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_RELATIVE_LOCATION_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_RELATIVE_LOCATION_PROPERTY = new FourCC("rloc", true)
static

Definition at line 57 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_ROTATE_PROPERTY

final FourCC com.nokia.heif.HEIF.FOURCC_ROTATE_PROPERTY = new FourCC("irot", true)
static

Definition at line 54 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetItemPropertyClasses().

◆ FOURCC_STEREO_PAIR

final FourCC com.nokia.heif.HEIF.FOURCC_STEREO_PAIR = new FourCC("ster", true)
static

Definition at line 49 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetEntityGroupClasses().

◆ FOURCC_VIDEO_TRACK

final FourCC com.nokia.heif.HEIF.FOURCC_VIDEO_TRACK = new FourCC("vide", true)
static

Definition at line 45 of file HEIF.java.

Referenced by com.nokia.heif.HEIF.resetTrackClasses().

◆ ITEM_CLASSES

Map<String, Class> com.nokia.heif.HEIF.ITEM_CLASSES = null
staticprivate

◆ ITEM_PROPERTY_CLASSES

Map<String, Class> com.nokia.heif.HEIF.ITEM_PROPERTY_CLASSES = null
staticprivate

◆ mNativeHandle

long com.nokia.heif.HEIF.mNativeHandle
protected

◆ SAMPLE_CLASSES

Map<String, Class> com.nokia.heif.HEIF.SAMPLE_CLASSES = null
staticprivate

◆ TAG

final String com.nokia.heif.HEIF.TAG = "HEIF"
staticprivate

Definition at line 27 of file HEIF.java.

◆ TRACK_CLASSES

Map<String, Class> com.nokia.heif.HEIF.TRACK_CLASSES = null
staticprivate

The documentation for this class was generated from the following file: