Working with EXIF metadata

What is EXIF?

According to the specification, EXIF (Exchangeable image file format) is a standard that specifies the formats to be used for images, sound and tags in digital still cameras and in other systems handling the image and sound files recorded by digital still cameras. Despite the confusing definition and name of the format, EXIF is just a metadata standard. In fact, it simply defines a way to store metadata properties in a variety of well-known image and audio formats. The EXIF tag structure is borrowed from TIFF files. The specification declares a set of tags intended to store technical details such as the geolocation of the place where a picture was taken, the name of the camera owner, camera settings, etc.

Please refer to the following article to get more information on the standard.

Reading basic EXIF properties

To access EXIF metadata in a file of any supported format, GroupDocs.Metadata provides the IExif.getExifPackage method. The following are the steps to read EXIF metadata:

Load a file that contains EXIF metadata
Extract the EXIF metadata package using the IExif.getExifPackage method

The following code snippet gets EXIF properties of a TIFF image and displays them on the screen.

advanced_usage.working_with_metadata_standards.exif.ReadBasicExifProperties

try (Metadata metadata = new Metadata(Constants.TiffWithExif)) {
	IExif root = (IExif) metadata.getRootPackage();
	if (root.getExifPackage() != null) {
		System.out.println(root.getExifPackage().getArtist());
		System.out.println(root.getExifPackage().getCopyright());
		System.out.println(root.getExifPackage().getImageDescription());
		System.out.println(root.getExifPackage().getMake());
		System.out.println(root.getExifPackage().getModel());
		System.out.println(root.getExifPackage().getSoftware());
		System.out.println(root.getExifPackage().getImageWidth());
		System.out.println(root.getExifPackage().getImageLength());

		// ...

		System.out.println(root.getExifPackage().getExifIfdPackage().getBodySerialNumber());
		System.out.println(root.getExifPackage().getExifIfdPackage().getCameraOwnerName());
		System.out.println(root.getExifPackage().getExifIfdPackage().getUserComment());

		// ...

		System.out.println(root.getExifPackage().getGpsPackage().getAltitude());
		System.out.println(root.getExifPackage().getGpsPackage().getLatitudeRef());
		System.out.println(root.getExifPackage().getGpsPackage().getLongitudeRef());

		// ...
	}
}

Reading all EXIF tags

In some cases, it’s necessary to read all EXIF properties from a file, including custom ones. To achieve this the GroupDocs.Metadata API provides direct access to the EXIF tags extracted from a file.

Load a file that contains EXIF metadata
Extract the EXIF metadata package using the IExif.getExifPackage method
Iterate through all EXIF tags on different levels

advanced_usage.working_with_metadata_standards.exif.ReadExifTags

try (Metadata metadata = new Metadata(Constants.JpegWithExif)) {
	IExif root = (IExif) metadata.getRootPackage();
	if (root.getExifPackage() != null) {
		String pattern = "%s = %s";

		for (TiffTag tag : root.getExifPackage().toList()) {
			System.out.println(String.format(pattern, tag.getTagID(), tag.getValue()));
		}

		for (TiffTag tag : root.getExifPackage().getExifIfdPackage().toList()) {
			System.out.println(String.format(pattern, tag.getTagID(), tag.getValue()));
		}

		for (TiffTag tag : root.getExifPackage().getGpsPackage().toList()) {
			System.out.println(String.format(pattern, tag.getTagID(), tag.getValue()));
		}
	}
}

Reading a specific EXIF tag

The GroupDocs.Metadata API also supports reading specific EXIF tags using a method that accepts the tag id as a parameter. Follow below-mentioned steps to read a specific EXIF tag.

Load a file that contains EXIF metadata
Extract the EXIF metadata package using the IExif.getExifPackage method
Get a specific tag using the getByTiffTagID method

advanced_usage.working_with_metadata_standards.exif.ReadSpecificExifTag

try (Metadata metadata = new Metadata(Constants.TiffWithExif)) {
    IExif root = (IExif) metadata.getRootPackage();
    if (root.getExifPackage() != null) {
        TiffAsciiTag software = (TiffAsciiTag) root.getExifPackage().getByTiffTagID(TiffTagID.Software);
        if (software != null) {
            System.out.println(String.format("Software: %s", software.getValue()));
        }
         
        TiffUndefinedTag comment = (TiffUndefinedTag)root.getExifPackage().getExifIfdPackage().getByTiffTagID(TiffTagID.UserComment);
        if (comment != null) {
            System.out.println(String.format("Comment: %s", comment.getInterpretedValue()));
        }
    }
}

Updating EXIF properties

The GroupDocs.Metadata API facilitates the user to update EXIF metadata in a convenient way - using the ExifPackage class methods. Follow the below steps to update EXIF metadata in a file of any supported format.

Load a file that contains EXIF metadata
Extract the EXIF metadata package using the IExif.getExifPackage method
Assign values to desired EXIF properties
Save the changes

advanced_usage.working_with_metadata_standards.exif.UpdateExifProperties

try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
	IExif root = (IExif) metadata.getRootPackage();
	// Set the EXIF package if it's missing
	if (root.getExifPackage() == null) {
		root.setExifPackage(new ExifPackage());
	}

	root.getExifPackage().setCopyright("Copyright (C) 2011-2020 GroupDocs. All Rights Reserved.");
	root.getExifPackage().setImageDescription("test image");
	root.getExifPackage().setSoftware("GroupDocs.Metadata");

	// ...

	root.getExifPackage().getExifIfdPackage().setBodySerialNumber("test");
	root.getExifPackage().getExifIfdPackage().setCameraOwnerName("GroupDocs");
	root.getExifPackage().getExifIfdPackage().setUserComment("test comment");

	// ...

	metadata.save(Constants.OutputJpeg);
}

Adding or updating custom EXIF tags

The GroupDocs.Metadata API allows adding or updating custom tags in an EXIF package.

Load a file that contains EXIF metadata
Extract the EXIF metadata package using the IExif.getExifPackage method
Set the EXIF package if it’s missing
Add any number of custom tags to the package
Save the changes

advanced_usage.working_with_metadata_standards.exif.SetCustomExifTag

try (Metadata metadata = new Metadata(Constants.TiffWithExif)) {
	IExif root = (IExif) metadata.getRootPackage();
	// Set the EXIF package if it's missing
	if (root.getExifPackage() == null) {
		root.setExifPackage(new ExifPackage());
	}

	// Add a known property
	root.getExifPackage().set(new TiffAsciiTag(TiffTagID.Artist, "test artist"));

	// Add a fully custom property (which is not described in the EXIF specification).
	// Please note that the chosen ID may intersect with the IDs used by some third party tools.
	root.getExifPackage().set(new TiffAsciiTag(65523, "custom"));
	metadata.save(Constants.OutputTiff);
}

Here is a full list of tags that can be added to an EXIF package:

Removing EXIF metadata

To remove the EXIF package from a file just pass null to the IExif.setExifPackage method. The code sample below shows how to remove EXIF metadata from a file.

advanced_usage.working_with_metadata_standards.exif.RemoveExifMetadata

try (Metadata metadata = new Metadata(Constants.JpegWithExif)) {
	IExif root = (IExif) metadata.getRootPackage();
	root.setExifPackage(null);
	metadata.save(Constants.OutputJpeg);
}

More resources

GitHub examples

You may easily run the code above and see the feature in action in our GitHub examples:

Free online document metadata management App

Along with full featured Java library we provide simple, but powerful free Apps.

You are welcome to view and edit metadata of PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, emails, images and more with our free online Free Online Document Metadata Viewing and Editing App.

Working with metadata standards Working with IPTC IIM metadata