gexiv2-sys

Rust FFI declarations for gexiv2

This crate provides Rust FFI declarations for the gexiv2 library, which is a GObject-based wrapper around Exiv2, which provides read and write access to the Exif, XMP, and IPTC metadata in media files.

Only FFI declarations are provided here; for a usable Rust library, consider the rexiv2 crate.

This project is considered “complete” — i.e. all the functionality that has been planned has been added (well, almost!), and no new development work is expected/planned. This doesn’t mean it’s abandoned or unsupported: bug reports and pull requests are still gladly welcomed and will be addressed.

Documentation

Documentation is available online, but since these are just FFI bindings, it is minimal.

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

Setup & Dependencies

Given that it links to gexiv2, and transitively to Exiv2, gexiv2-sys obviously depends on them. These libraries are not bundled with gexiv2-sys: you will need to install them separately.

The minimum supported rustc version is 1.63.

For full instructions on how to get started with gexiv2-sys, including how to install the prerequisite dependencies, refer to the SETUP file.

Optional Features

raw-tag-access: If you need access to the raw byte values of tags, you can enable this feature and gain the gexiv2_metadata_get_tag_raw function. Note that the return value of this call is a GLib GBytes object, which you can convert to a data pointer via GLib’s g_bytes_unref_to_data.

This feature is disabled by default because it introduces a new dependency on glib-sys, and consequently on the GLib system library.

xmp-packet-access: If you need access to the XML-formatted XMP packet, you can enable this feature. It will add the gexiv2_metadata_generate_xmp_packet and gexiv2_metadata_get_xmp_packet calls. Enabling the feature also introduces a new dependency on the the bitflags crate.

Contributions & Bug Reports

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

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

Bug reports and feature requests can also be sent through GitHub Issues or by email, and are very welcome and appreciated.

For more information, see the CONTRIBUTING file.

Copyright & License

The Exiv2 and gexiv2 libraries are both released under the terms of the GNU General Public License (GPL), and since gexiv2-sys 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.