Repository files navigation

Kim is a Kotlin Multiplatform library for reading and writing image metadata.

It's part ofAshampoo Photo Organizer.

• JPG: Read & Write EXIF, IPTC & XMP
• PNG: Read & WriteeXIf chunk & XMP
  • Also read non-standard EXIF & IPTC fromtEXt/zTXt chunk
• WebP: Read & Write EXIF & XMP
• HEIC / AVIF: Read EXIF & XMP
• JXL: Read & Write EXIF & XMP of uncompressed files
• TIFF / RAW: Read EXIF & XMP
  • Full support for Adobe DNG, Canon CR2, Canon CR3 & Fujifilm RAF
  • Support for Nikon NEF, Sony ARW & Olympus ORF without lens info
  • Support for Panasonic RW2 without lens info and image size
  • API for preview image extraction of DNG, CR2, CR3, RAF, NEF, ARW & RW2
• Handling of XMP content throughXMP Core for Kotlin Multiplatform
• ConvenientKim.update() API to perform updates to the relevant places
  • JPG: Lossless rotation by modifying only one byte (where present)

The future development of features on our part is driven entirely by the needsof Ashampoo Photo Organizer, which, in turn, is driven by user community feedback.

implementation("com.ashampoo:kim:0.23")

For the targetswasmJs &js you also need to specify this:

implementation(npm("pako", "2.1.0"))

Kim.readMetadata() takeskotlin.ByteArray on all platforms and depending onthe platform alsokotlinx.io.files.Path, KtorSource &ByteReadChannel,java.io.File,java.io.InputStream,NSData andString paths.

val bytes:ByteArray= loadBytes()val metadata=Kim.readMetadata(bytes)/* ImageMetadata has a proper toString() similar to the output of ExifTool*/println(metadata)val orientation= metadata.findShortValue(TiffTag.TIFF_TAG_ORIENTATION)println("Orientation:$orientation")val takenDate= metadata.findStringValue(ExifTag.EXIF_TAG_DATE_TIME_ORIGINAL)println("Taken date:$takenDate")

This creates an instance ofPhotoMetadata.It contains the following:

• Image size
• Orientation
• Date taken
• GPS coordinates
• Camera make & model
• Lens make & model
• ISO, Exposure time, F-Number, Focal length
• Image title & description
• Rating
• XMP:pick flag
• Keywords
• Faces (XMP-mwg-rs regions, used by Picasa and others)
• Persons in image

val bytes:ByteArray= loadBytes()val photoMetadata=Kim.readMetadata(bytes).convertToPhotoMetadata()

val inputFile=File("myphoto.jpg")val outputFile=File("myphoto_changed.jpg")val metadata=Kim.readMetadata(inputFile)val outputSet:TiffOutputSet= metadata.exif?.createOutputSet()?:TiffOutputSet()val rootDirectory= outputSet.getOrCreateRootDirectory()rootDirectory.removeField(TiffTag.TIFF_TAG_ORIENTATION)rootDirectory.add(TiffTag.TIFF_TAG_ORIENTATION,8)OutputStreamByteWriter(outputFile.outputStream()).use { outputStreamByteWriter->JpegRewriter.updateExifMetadataLossless(        byteReader=JvmInputStreamByteReader(inputFile.inputStream(), inputFile.length()),        byteWriter= outputStreamByteWriter,        outputSet= outputSet    )}

See theexample project for more details.

val bytes:ByteArray= loadBytes()val newBytes=Kim.update(    bytes= bytes,    update=MetadataUpdate.Orientation(TiffOrientation.ROTATE_RIGHT))

SeeAbstractUpdaterTest for more samples.

val bytes:ByteArray= loadBytes()val thumbnailBytes:ByteArray= loadThumbnailBytes()val newBytes=Kim.updateThumbnail(    bytes= bytes,    thumbnailBytes= thumbnailBytes)

See theJava example project how to use Kim in Java projects.

• Inability to update EXIF, IPTC and XMP in JPG files simultaneously.
• Does not read the image size and orientation for HEIC, AVIF & JPEG XL.
• Does not read brotli compressed metadata of JPEG XL due to missing brotli KMP libs.
• MakerNote support is experimental and limited.
  • Can't extract preview image of ORF as offsets are burried into MakerNote.
  • Can't identify lens info of NEF, ARW, RW2 & ORF because this is constructed from MakerNote fields.
  • Missing image size for RW2 as this is also burried in MakerNotes.
• There is right now no convienient tooling for GeoTiff like there is for GPS.

In the processing of HEIC and AVIF files, we handle them as standardISOBMFF-based files, adhering rigorously to the EIC/ISO 14496-12 specification.To preempt potential legal issues, we intentionally omit certain boxes outlinedin the HEIC specification, notably the image size ("ispe") and image rotation ("irot") boxes.This approach extends to AVIF images, as they repurpose the same boxes.

Contributions to Ashampoo Kim are welcome! If you encounter any issues,have suggestions for improvements, or would like to contribute new features,please feel free to submit a pull request.

• JetBrains for makingKotlin.
• Apache Software Foundation for makingApache Commons Imaging.
• Drew Noakes for makingmetadata-extractor.
• Phil Harvey for makingExifTool.
• Unsplash for providing test images.

This code is under theApache License 2.0.

See theNOTICE.txt file for required notices and attributions.