Skip to content

Ashampoo/xmpcore

Repository files navigation

XMP Core for Kotlin Multiplatform

Kotlin JVM Android iOS Windows Linux macOS JS WASM WASI Coverage Maven Central

This library is a port of Adobe's XMP SDK to Kotlin Multiplatform by Ashampoo.

It's part of Ashampoo Photo Organizer.

Installation

implementation("com.ashampoo:xmpcore:1.3.0")

How to use

The library has been designed as a drop-in replacement for users who previously employed XMP Core Java. Therefore, all the documentation applicable to the Java SDK also pertains to this library. However, please note that we have made the decision to remove the functionality for reading from and writing to ByteArray and InputStreams, as we believe it is unnecessary.

Sample code

val originalXmp: String = "... your XMP ..."

val xmpMeta: XMPMeta = XMPMetaFactory.parseFromString(originalXmp)

val xmpSerializeOptions =
    SerializeOptions()
        .setOmitXmpMetaElement(false)
        .setOmitPacketWrapper(false)
        .setUseCompactFormat(true)
        .setSort(true)

val newXmp = XMPMetaFactory.serializeToString(xmpMeta, xmpSerializeOptions)

Check out the Kotlin JVM example project.

For usage in Java projects check out the Java example project.

Also see the unit tests ReadXmpTest and WriteXmpTest to learn more about reading and manipulating data.

Migration hint

If you have previously utilized the official XMP Core Java library available on Maven Central, please make sure to update your imports from com.adobe.internal.xmp to com.ashampoo.xmp.

Contributions

Contributions to this project 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.

Acknowledgements

  • JetBrains for making Kotlin.
  • Adobe for making the XMP Core Java SDK.
  • Paul de Vrieze for making XmlUtil.

License

The same BSD license applies to this project as to Adobe's open source XMP SDK, from which it is derived.

Note: The original license page went offline, but you can still find it on archive.org.