xmpkit 0.1.4

Pure Rust implementation of Adobe XMP Toolkit
Documentation 
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

//! Tests for XmpMeta API
//!
//! These tests are adapted from the original xmp-toolkit-rs tests
//! to work with our pure Rust implementation.

use xmpkit::XmpMeta;

#[test]
fn new_empty() {
    let m = XmpMeta::new();
    // Empty XmpMeta has no properties
    assert!(!m.has_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"));
}

#[test]
fn default() {
    let m = XmpMeta::default();
    // Empty XmpMeta has no properties
    assert!(!m.has_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"));
}

mod from_str {
    use xmpkit::{XmpMeta, XmpValue};

    const SIMPLE_XMP: &str = r#"<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
         xmlns:xmp="http://ns.adobe.com/xap/1.0/">
  <rdf:Description rdf:about=""
                   xmp:CreatorTool="Adobe Photoshop CS2 Windows"/>
</rdf:RDF>
<?xpacket end="w"?>"#;

    const GOOGLE_PANO_XMP: &str = r#"<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>
    <x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="XMP Core 5.5.0">
        <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
            <rdf:Description
                rdf:about=""
                xmlns:GPano="http://ns.google.com/photos/1.0/panorama/"
                xmlns:GCamera="http://ns.google.com/photos/1.0/camera/"
                GPano:UsePanoramaViewer="True"
                GPano:IsPhotosphere="True"
                GPano:ProjectionType="equirectangular"
                GPano:CroppedAreaImageHeightPixels="4000"
                GPano:CroppedAreaImageWidthPixels="8000"
                GPano:FullPanoHeightPixels="4000"
                GPano:FullPanoWidthPixels="8000"
                GPano:CroppedAreaTopPixels="0"
                GPano:CroppedAreaLeftPixels="0"
                GPano:FirstPhotoDate="2022-05-17T10:29:50+00:00"
                GPano:LastPhotoDate="2022-05-17T10:32:42+00:00"
                GPano:SourcePhotosCount="38"
                GPano:PoseHeadingDegrees="276"
                GPano:LargestValidInteriorRectLeft="0"
                GPano:LargestValidInteriorRectTop="0"
                GPano:LargestValidInteriorRectWidth="8704"
                GPano:LargestValidInteriorRectHeight="4352"
            >
                <GCamera:SpecialTypeID>
                    <rdf:Bag>
                        <rdf:li>com.google.android.apps.camera.gallery.specialtype.SpecialType-PHOTOSPHERE</rdf:li>
                    </rdf:Bag>
                </GCamera:SpecialTypeID>
            </rdf:Description>
        </rdf:RDF>
    </x:xmpmeta>
<?xpacket end="w"?>"#;

    #[test]
    fn happy_path() {
        let m = SIMPLE_XMP.parse::<XmpMeta>().unwrap();

        assert_eq!(
            m.get_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"),
            Some(XmpValue::String("Adobe Photoshop CS2 Windows".to_string()))
        );
    }

    #[test]
    fn parse_google_pano_xmp() {
        let m = GOOGLE_PANO_XMP.parse::<XmpMeta>().unwrap();

        let gp_ns = "http://ns.google.com/photos/1.0/panorama/";
        assert_eq!(
            m.get_property(gp_ns, "UsePanoramaViewer"),
            Some(XmpValue::String("True".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "IsPhotosphere"),
            Some(XmpValue::String("True".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "ProjectionType"),
            Some(XmpValue::String("equirectangular".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "CroppedAreaImageHeightPixels"),
            Some(XmpValue::String("4000".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "CroppedAreaImageWidthPixels"),
            Some(XmpValue::String("8000".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "FullPanoHeightPixels"),
            Some(XmpValue::String("4000".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "FullPanoWidthPixels"),
            Some(XmpValue::String("8000".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "CroppedAreaTopPixels"),
            Some(XmpValue::String("0".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "CroppedAreaLeftPixels"),
            Some(XmpValue::String("0".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "FirstPhotoDate"),
            Some(XmpValue::String("2022-05-17T10:29:50+00:00".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "LastPhotoDate"),
            Some(XmpValue::String("2022-05-17T10:32:42+00:00".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "SourcePhotosCount"),
            Some(XmpValue::String("38".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "PoseHeadingDegrees"),
            Some(XmpValue::String("276".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "LargestValidInteriorRectLeft"),
            Some(XmpValue::String("0".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "LargestValidInteriorRectTop"),
            Some(XmpValue::String("0".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "LargestValidInteriorRectWidth"),
            Some(XmpValue::String("8704".to_string()))
        );
        assert_eq!(
            m.get_property(gp_ns, "LargestValidInteriorRectHeight"),
            Some(XmpValue::String("4352".to_string()))
        );

        let gc_ns = "http://ns.google.com/photos/1.0/camera/";
        assert_eq!(m.get_array_size(gc_ns, "SpecialTypeID"), Some(1));
        assert_eq!(
            m.get_array_item(gc_ns, "SpecialTypeID", 0),
            Some(XmpValue::String(
                "com.google.android.apps.camera.gallery.specialtype.SpecialType-PHOTOSPHERE"
                    .to_string()
            ))
        );
        assert_eq!(
            m.get_property(gc_ns, "SpecialTypeID[1]"),
            Some(XmpValue::String(
                "com.google.android.apps.camera.gallery.specialtype.SpecialType-PHOTOSPHERE"
                    .to_string()
            ))
        );
    }

    #[test]
    fn parse_mwg_regions_with_description() {
        let xmp_str = r#"<x:xmpmeta xmlns:x="adobe:ns:meta/">
 <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
  <rdf:Description rdf:about=""
    xmlns:mwg-rs="http://www.metadataworkinggroup.com/schemas/regions/">
   <mwg-rs:Regions>
    <mwg-rs:RegionList>
     <rdf:Seq>
      <rdf:li>
       <mwg-rs:Description>This is a region description</mwg-rs:Description>
      </rdf:li>
     </rdf:Seq>
    </mwg-rs:RegionList>
   </mwg-rs:Regions>
  </rdf:Description>
 </rdf:RDF>
</x:xmpmeta>"#;

        let meta = xmp_str.parse::<XmpMeta>().unwrap();
        let path = "Regions/mwg-rs:RegionList[1]/mwg-rs:Description";
        let ns = "http://www.metadataworkinggroup.com/schemas/regions/";

        assert_eq!(
            meta.get_property(ns, path),
            Some(XmpValue::String("This is a region description".to_string()))
        );
    }

    #[test]
    fn invalid_xml() {
        let result = "not valid xml".parse::<XmpMeta>();
        assert!(result.is_err());
    }
}

mod property_operations {
    use xmpkit::{XmpMeta, XmpValue};

    #[test]
    fn set_and_get_property() {
        let mut m = XmpMeta::new();

        m.set_property(
            "http://ns.adobe.com/xap/1.0/",
            "CreatorTool",
            XmpValue::String("TestApp".to_string()),
        )
        .unwrap();

        assert_eq!(
            m.get_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"),
            Some(XmpValue::String("TestApp".to_string()))
        );
    }

    #[test]
    fn has_property() {
        let mut m = XmpMeta::new();

        assert!(!m.has_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"));

        m.set_property(
            "http://ns.adobe.com/xap/1.0/",
            "CreatorTool",
            XmpValue::String("TestApp".to_string()),
        )
        .unwrap();

        assert!(m.has_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"));
        assert!(!m.has_property("http://ns.adobe.com/xap/1.0/", "NonExistent"));
    }

    #[test]
    fn delete_property() {
        let mut m = XmpMeta::new();

        m.set_property(
            "http://ns.adobe.com/xap/1.0/",
            "CreatorTool",
            XmpValue::String("TestApp".to_string()),
        )
        .unwrap();

        assert!(m.has_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"));

        m.delete_property("http://ns.adobe.com/xap/1.0/", "CreatorTool")
            .unwrap();

        assert!(!m.has_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"));
    }
}

mod serialize {
    use xmpkit::{XmpMeta, XmpValue};

    #[test]
    fn serialize_rdf() {
        let mut m = XmpMeta::new();
        m.set_property(
            "http://ns.adobe.com/xap/1.0/",
            "CreatorTool",
            XmpValue::String("TestApp".to_string()),
        )
        .unwrap();

        let serialized = m.serialize().unwrap();
        assert!(serialized.contains("rdf:RDF"));
        assert!(serialized.contains("rdf:Description"));
        assert!(serialized.contains("CreatorTool"));
    }

    #[test]
    fn serialize_packet() {
        let mut m = XmpMeta::new();
        m.set_property(
            "http://ns.adobe.com/xap/1.0/",
            "CreatorTool",
            XmpValue::String("TestApp".to_string()),
        )
        .unwrap();

        let packet = m.serialize_packet().unwrap();
        assert!(packet.contains("<?xpacket"));
        assert!(packet.contains("rdf:RDF"));
    }

    #[test]
    fn round_trip() {
        let original_xmp = r#"<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
         xmlns:xmp="http://ns.adobe.com/xap/1.0/">
  <rdf:Description rdf:about=""
                   xmp:CreatorTool="TestApp"/>
</rdf:RDF>
<?xpacket end="w"?>"#;

        let m1 = original_xmp.parse::<XmpMeta>().unwrap();
        let serialized = m1.serialize_packet().unwrap();
        let m2 = serialized.parse::<XmpMeta>().unwrap();

        assert_eq!(
            m1.get_property("http://ns.adobe.com/xap/1.0/", "CreatorTool"),
            m2.get_property("http://ns.adobe.com/xap/1.0/", "CreatorTool")
        );
    }
}