rexiv2

Rust library for working with media file metadata

This library provides a Rust wrapper around the gexiv2 library, which is a GObject-based wrapper around the Exiv2 library, which provides read and write access to the Exif, XMP, and IPTC metadata in media files (typically photos) in various formats.

Documentation

API documentation is available online.

Exiv2’s homepage has documentation on available namespaces and tags.

gexiv2’s APIs may also be a useful reference, along with Exiv2’s API docs.

During development and testing, the Exiv2 command-line utility may come in handy.

Dependencies

Being a wrapper for Exiv2, and gexiv2, rexiv2 obviously depends on them. Only the library (e.g. .so or .dll) files are needed; not the headers or source code. You can download these dependencies from their download pages: Exiv2; gexiv2.

On a Linux system, you can typically install these dependencies through your package manager (look for packages with names like “libgexiv2-dev”). Mac OS X users may also have this option through unofficial package management systems. Note that to build rexiv2 from source you may need not just the library packages, but the “dev” versions of them as well.

Versioning & History

rexiv2 is currently only available in an unstable development version.

Version numbers follow the principles of Semantic Versioning. In particular, this means that once development reaches the 1.0.0 version, the API will be considered stable, and any changes will be made gradually and gracefully across multiple versions, with reasonable deprecation timelines. But, until then, don’t rely on the API working the same way from minor version to minor version.

See the CHANGELOG file for a history of released versions.

Contributing

Contributions are gladly accepted, either through GitHub pull requests or by mailing patches to felixc@felixcrux.com (PGP key 8569B6311EE485F8).

It is strongly recommended that you indicate your intent to contribute by opening an issue on the tracker (or commenting on an existing one) describing the bug you are fixing or the improvement you intend to make. This helps prevent duplication of efforts and allows for discussion of e.g. API specifics before too much time is spent on implementation.

By contributing, you are agreeing to make your contribution available under the same license terms as the rest of the project.

Copyright & License

The Exiv2 and gexiv2 libraries are both released under the terms of the GNU General Public License (GPL), and since rexiv2 is linked to them, it too is made available under the terms of the GPL. Specifically:

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Please refer to the LICENSE file for a full copy of the license.