1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
// Copyright 2020 Adobe. All rights reserved.
// This file is licensed to you under the Apache License,
// Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
// or the MIT license (http://opensource.org/licenses/MIT),
// at your option.
// Unless required by applicable law or agreed to in writing,
// this software is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or
// implied. See the LICENSE-MIT and LICENSE-APACHE files for the
// specific language governing permissions and limitations under
// each license.
use std::{ffi::CString, path::Path};
use crate::{ffi, XmpError, XmpErrorType, XmpMeta, XmpResult};
/// Provides access to the main (document-level) metadata in many file formats.
///
/// This provides convenient access to the main, or document level, XMP for a
/// file. Use it to obtain metadata from a file, which you can then manipulate
/// with the [`XmpMeta`] struct and to write new or changed metadata back out
/// to a file.
///
/// The functions allow you to open a file, read and write the metadata, then
/// close the file. While open, portions of the file might be maintained in RAM
/// data structures. Memory usage can vary considerably depending on file format
/// and access options.
///
/// A file can be opened for read-only or read-write access, with typical
/// exclusion for both modes.
pub struct XmpFile {
f: *mut ffi::CXmpFile,
}
impl Drop for XmpFile {
fn drop(&mut self) {
unsafe {
ffi::CXmpFileDrop(self.f);
}
}
}
impl XmpFile {
/// Creates a new file struct that is associated with no file.
///
/// An error result from this function is unlikely but possible
/// if, for example, the C++ XMP Toolkit fails to initialize or
/// reports an out-of-memory condition.
pub fn new() -> XmpResult<XmpFile> {
let mut err = ffi::CXmpError::default();
let f = unsafe { ffi::CXmpFileNew(&mut err) };
XmpError::raise_from_c(&err)?;
Ok(XmpFile { f })
}
/// Opens a file for the requested forms of metadata access.
///
/// Opening the file, at a minimum, causes the raw XMP packet to be read
/// from the file. If the file handler supports legacy metadata
/// reconciliation then legacy metadata is also read, unless
/// `kXMPFiles_OpenOnlyXMP` is passed.
///
/// If the file is opened for read-only access (passing
/// [`OpenFileOptions::for_read`]), the disk file is closed
/// immediately after reading the data from it; the `XMPFile` struct,
/// however, remains in the open state until `drop` is called.
///
/// If you update the XMP, you must call [`XmpFile::put_xmp`] before the
/// struct is dropped; if you do not, any pending updates are lost.
///
/// Typically, the XMP is not parsed and legacy reconciliation is not
/// performed until [`XmpFile::xmp`] is called, but this is not
/// guaranteed. Specific file handlers might do earlier parsing of the
/// XMP. Delayed parsing and early disk file close for read-only
/// access are optimizations to help clients implementing file browsers, so
/// that they can access the file briefly and possibly display a
/// thumbnail, then postpone more expensive XMP processing until later.
///
/// ## Arguments
///
/// * `path`: The path for the file.
///
/// * `flags`: A set of option flags that describe the desired access. By
/// default ([`OpenFileOptions::default`]), the file is opened for
/// read-only access and the format handler decides on the level of
/// reconciliation that will be performed. See [`OpenFileOptions`] for
/// other options.
pub fn open_file<P: AsRef<Path>>(&mut self, path: P, flags: OpenFileOptions) -> XmpResult<()> {
if let Some(c_path) = path_to_cstr(path.as_ref()) {
let mut err = ffi::CXmpError::default();
unsafe {
ffi::CXmpFileOpen(self.f, &mut err, c_path.as_ptr(), flags.options);
}
XmpError::raise_from_c(&err)
} else {
Err(XmpError {
error_type: XmpErrorType::BadParam,
debug_message: "Could not convert path to C string".to_owned(),
})
}
}
/// Retrieves the XMP metadata from an open file.
///
/// If no XMP is present, will return `None`.
pub fn xmp(&mut self) -> Option<XmpMeta> {
unsafe {
let m = ffi::CXmpFileGetXmp(self.f);
if m.is_null() {
None
} else {
Some(XmpMeta { m: Some(m) })
}
}
}
/// Reports whether this file can be updated with a specific XMP packet.
///
/// Use this function to determine if the file can probably be updated with
/// a given set of XMP metadata. This depends on the size of the packet,
/// the options with which the file was opened, and the capabilities of
/// the handler for the file format. The function obtains the length of
/// the serialized packet for the provided XMP, but does not keep it or
/// modify it, and does not cause the file to be written when closed.
pub fn can_put_xmp(&self, meta: &XmpMeta) -> bool {
if let Some(m) = meta.m {
unsafe { ffi::CXmpFileCanPutXmp(self.f, m) != 0 }
} else {
false
}
}
/// Updates the XMP metadata in this object without writing out the file.
///
/// This function supplies new XMP for the file. However, the disk file is
/// not written until the struct is closed with [`XmpFile::close`].
/// The options provided when the file was opened determine if
/// reconciliation is done with other forms of metadata.
pub fn put_xmp(&mut self, meta: &XmpMeta) -> XmpResult<()> {
if let Some(m) = meta.m {
let mut err = ffi::CXmpError::default();
unsafe { ffi::CXmpFilePutXmp(self.f, &mut err, m) };
XmpError::raise_from_c(&err)
} else {
Err(crate::xmp_meta::no_cpp_toolkit())
}
}
/// Explicitly closes an opened file.
///
/// Performs any necessary output to the file and closes it. Files that are
/// opened for update are written to only when closing.
///
/// If the file is opened for read-only access (passing
/// [`OpenFileOptions::for_read`]), the disk file is closed
/// immediately after reading the data from it; the `XMPFile`
/// struct, however, remains in the open state. You must call
/// [`XmpFile::close`] when finished using it. Other methods, such as
/// [`XmpFile::xmp`], can only be used between the
/// [`XmpFile::open_file`] and [`XmpFile::close`] calls. The `XMPFile`
/// destructor does not call [`XmpFile::close`]; if the struct is
/// dropped without closing, any pending updates are lost.
///
/// If the file is opened for update (passing
/// [`OpenFileOptions::for_update`]), the disk file remains open until
/// [`XmpFile::close`] is called. The disk file is only updated once,
/// when [`XmpFile::close`] is called, regardless of how many calls are
/// made to [`XmpFile::put_xmp`].
pub fn close(&mut self) {
unsafe { ffi::CXmpFileClose(self.f) };
}
}
/// Option flags for [`XmpFile::open_file`].
///
/// Invoke by calling [`OpenFileOptions::default`] and then calling methods
/// on this struct to add options as needed.
#[derive(Default)]
pub struct OpenFileOptions {
pub(crate) options: u32,
}
impl OpenFileOptions {
/// Open for read-only access.
///
/// See `kXMPFiles_OpenForRead` constant in C++ SDK.
pub fn for_read(mut self) -> Self {
self.options |= 0x00000001;
self
}
/// Open for reading and writing.
///
/// See `kXMPFiles_OpenForUpdate` constant in C++ SDK.
pub fn for_update(mut self) -> Self {
self.options |= 0x00000002;
self
}
/// Only the XMP is wanted.
///
/// This allows space/time optimizations.
///
/// See `kXMPFiles_OpenOnlyXMP` constant in C++ SDK.
pub fn only_xmp(mut self) -> Self {
self.options |= 0x00000004;
self
}
/// Force use of the given handler (format).
///
/// Do not even verify the format.
///
/// See `kXMPFiles_ForceGivenHandler` constant in C++ SDK.
pub fn force_given_handler(mut self) -> Self {
self.options |= 0x00000008;
self
}
/// Be strict about only attempting to use the designated file handler.
///
/// Do not fall back to other handlers.
///
/// See `kXMPFiles_OpenStrictly` constant in C++ SDK.
pub fn strict(mut self) -> Self {
self.options |= 0x00000010;
self
}
/// Require the use of a smart handler.
///
/// See `kXMPFiles_OpenUseSmartHandler` constant in C++ SDK.
pub fn use_smart_handler(mut self) -> Self {
self.options |= 0x00000020;
self
}
/// Force packet scanning.
///
/// Do not use a smart handler.
///
/// See `kXMPFiles_OpenUsePacketScanning` constant in C++ SDK.
pub fn use_packet_scanning(mut self) -> Self {
self.options |= 0x00000040;
self
}
/// Only packet scan files "known" to need scanning.
///
/// See `kXMPFiles_OpenLimitedScanning` constant in C++ SDK.
pub fn limited_scanning(mut self) -> Self {
self.options |= 0x00000080;
self
}
/// Attempt to repair a file opened for update.
///
/// Default is to not open (throw an exception).
///
/// See `kXMPFiles_OpenRepairFile` constant in C++ SDK.
pub fn repair_file(mut self) -> Self {
self.options |= 0x00000100;
self
}
/// When updating a file, spend the effort necessary to optimize file
/// layout.
///
/// See `kXMPFiles_OptimizeFileLayout` constant in C++ SDK.
pub fn optimize_file_layout(mut self) -> Self {
self.options |= 0x00000200;
self
}
}
fn path_to_cstr(path: &Path) -> Option<CString> {
path.to_str()
.and_then(|path_str| CString::new(path_str).ok())
}