Merge pull request #455 from drewnoakes/uuid

Add support for MP4 UUID and MOV XMP boxes
drewnoakes · Jan 15, 2020 · 482cb69 · 482cb69
2 parents bb78cb0 + 96b7bc1
commit 482cb69
Show file tree

Hide file tree

Showing 12 changed files with 306 additions and 7 deletions.
diff --git a/Source/com/drew/imaging/mp4/Mp4Reader.java b/Source/com/drew/imaging/mp4/Mp4Reader.java
@@ -62,7 +62,11 @@ private static void processBoxes(StreamReader reader, long atomEnd, Mp4Handler h
                 } else if (box.usertype != null) {
                     reader.skip(box.size - 24);
                 } else if (box.size > 1) {
-                    reader.skip(box.size - 8);
+                    if (box.isLargeSize) {
+                        reader.skip(box.size - 16);
+                    } else {
+                        reader.skip(box.size - 8);
+                    }
                 } else if (box.size == -1) {
                     break;
                 }

diff --git a/Source/com/drew/metadata/mov/QuickTimeAtomHandler.java b/Source/com/drew/metadata/mov/QuickTimeAtomHandler.java
@@ -28,6 +28,7 @@
 import com.drew.metadata.Metadata;
 import com.drew.metadata.mov.atoms.*;
 import com.drew.metadata.mov.atoms.canon.CanonThumbnailAtom;
+import com.drew.metadata.xmp.XmpReader;
 
 import java.io.IOException;
 
@@ -57,7 +58,8 @@ public boolean shouldAcceptAtom(@NotNull Atom atom)
             || atom.type.equals(QuickTimeAtomTypes.ATOM_MOVIE_HEADER)
             || atom.type.equals(QuickTimeAtomTypes.ATOM_HANDLER)
             || atom.type.equals(QuickTimeAtomTypes.ATOM_MEDIA_HEADER)
-            || atom.type.equals(QuickTimeAtomTypes.ATOM_CANON_THUMBNAIL);
+            || atom.type.equals(QuickTimeAtomTypes.ATOM_CANON_THUMBNAIL)
+            || atom.type.equals(QuickTimeAtomTypes.ATOM_ADOBE_XMP);
     }
 
     @Override
@@ -90,6 +92,8 @@ public QuickTimeHandler processAtom(@NotNull Atom atom, @Nullable byte[] payload
             } else if (atom.type.equals(QuickTimeAtomTypes.ATOM_CANON_THUMBNAIL)) {
                 CanonThumbnailAtom canonThumbnailAtom = new CanonThumbnailAtom(reader);
                 canonThumbnailAtom.addMetadata(directory);
+            } else if (atom.type.equals(QuickTimeAtomTypes.ATOM_ADOBE_XMP)) {
+                new XmpReader().extract(payload, metadata, directory);
             }
         } else {
             if (atom.type.equals(QuickTimeContainerTypes.ATOM_COMPRESSED_MOVIE)) {

diff --git a/Source/com/drew/metadata/mov/QuickTimeAtomTypes.java b/Source/com/drew/metadata/mov/QuickTimeAtomTypes.java
@@ -40,6 +40,7 @@ public class QuickTimeAtomTypes
     public static final String ATOM_TIME_TO_SAMPLE           = "stts";
     public static final String ATOM_MEDIA_HEADER             = "mdhd";
     public static final String ATOM_CANON_THUMBNAIL          = "CNTH";
+    public static final String ATOM_ADOBE_XMP                = "XMP_";
 
     private static final ArrayList<String> _atomList = new ArrayList<String>();
 
@@ -57,5 +58,6 @@ public class QuickTimeAtomTypes
         _atomList.add(ATOM_TIME_TO_SAMPLE);
         _atomList.add(ATOM_MEDIA_HEADER);
         _atomList.add(ATOM_CANON_THUMBNAIL);
+        _atomList.add(ATOM_ADOBE_XMP);
     }
 }
diff --git a/Source/com/drew/metadata/mov/QuickTimeDirectory.java b/Source/com/drew/metadata/mov/QuickTimeDirectory.java
@@ -54,6 +54,8 @@ public class QuickTimeDirectory extends Directory {
 
     public static final int TAG_CANON_THUMBNAIL_DT                      = 0x2000;
 
+    public static final int TAG_ADOBE_XMP                               = 0x3000;
+
     @NotNull
     private static final HashMap<Integer, String> _tagNameMap = new HashMap<Integer, String>();
 
@@ -80,6 +82,8 @@ public class QuickTimeDirectory extends Directory {
         _tagNameMap.put(TAG_MEDIA_TIME_SCALE, "Media Time Scale");
 
         _tagNameMap.put(TAG_CANON_THUMBNAIL_DT, "Canon Thumbnail DateTime");
+
+        _tagNameMap.put(TAG_ADOBE_XMP, "Adobe Bridge XMP");
     }
 
     public QuickTimeDirectory()

diff --git a/Source/com/drew/metadata/mp4/Mp4BoxHandler.java b/Source/com/drew/metadata/mp4/Mp4BoxHandler.java
@@ -27,6 +27,7 @@
 import com.drew.lang.annotations.Nullable;
 import com.drew.metadata.Metadata;
 import com.drew.metadata.mp4.boxes.*;
+import com.drew.metadata.mp4.media.Mp4UuidBoxHandler;
 
 import java.io.IOException;
 
@@ -56,7 +57,8 @@ public boolean shouldAcceptBox(@NotNull Box box)
             || box.type.equals(Mp4BoxTypes.BOX_MOVIE_HEADER)
             || box.type.equals(Mp4BoxTypes.BOX_HANDLER)
             || box.type.equals(Mp4BoxTypes.BOX_MEDIA_HEADER)
-            || box.type.equals(Mp4BoxTypes.BOX_TRACK_HEADER);
+            || box.type.equals(Mp4BoxTypes.BOX_TRACK_HEADER)
+            || box.type.equals(Mp4BoxTypes.BOX_USER_DEFINED);
     }
 
     @Override
@@ -84,6 +86,9 @@ public Mp4Handler processBox(@NotNull Box box, @Nullable byte[] payload, Mp4Cont
                 processMediaHeader(reader, box, context);
             } else if (box.type.equals(Mp4BoxTypes.BOX_TRACK_HEADER)) {
                 processTrackHeader(reader, box);
+            } else if (box.type.equals(Mp4BoxTypes.BOX_USER_DEFINED)) {
+                Mp4UuidBoxHandler userBoxHandler = new Mp4UuidBoxHandler(metadata);
+                userBoxHandler.processBox(box, payload, context);
             }
         } else {
             if (box.type.equals(Mp4ContainerTypes.BOX_COMPRESSED_MOVIE)) {

diff --git a/Source/com/drew/metadata/mp4/Mp4BoxTypes.java b/Source/com/drew/metadata/mp4/Mp4BoxTypes.java
@@ -38,6 +38,7 @@ public class Mp4BoxTypes
     public static final String BOX_TIME_TO_SAMPLE                   = "stts";
     public static final String BOX_MEDIA_HEADER                     = "mdhd";
     public static final String BOX_TRACK_HEADER                     = "tkhd";
+    public static final String BOX_USER_DEFINED                     = "uuid";
 
     private static final ArrayList<String> _boxList = new ArrayList<String>();
 
@@ -53,5 +54,6 @@ public class Mp4BoxTypes
         _boxList.add(BOX_TIME_TO_SAMPLE);
         _boxList.add(BOX_MEDIA_HEADER);
         _boxList.add(BOX_TRACK_HEADER);
+        _boxList.add(BOX_USER_DEFINED);
     }
 }
diff --git a/Source/com/drew/metadata/mp4/boxes/Box.java b/Source/com/drew/metadata/mp4/boxes/Box.java
@@ -32,19 +32,18 @@ public class Box
     public long size;
     public String type;
     public String usertype;
+    public boolean isLargeSize;
 
     public Box(SequentialReader reader) throws IOException
     {
         this.size = reader.getUInt32();
         this.type = reader.getString(4);
         if (size == 1) {
             size = reader.getInt64();
+            isLargeSize = true;
         } else if (size == 0) {
             size = -1;
         }
-        if (type.equals("uuid")) {
-            usertype = reader.getString(16);
-        }
     }
 
     public Box(Box box)

diff --git a/Source/com/drew/metadata/mp4/boxes/MediaHeaderBox.java b/Source/com/drew/metadata/mp4/boxes/MediaHeaderBox.java
@@ -22,7 +22,6 @@
 
 import com.drew.lang.SequentialReader;
 import com.drew.metadata.mp4.Mp4Context;
-import com.drew.metadata.mp4.Mp4HandlerFactory;
 
 import java.io.IOException;
 

diff --git a/Source/com/drew/metadata/mp4/boxes/UuidBox.java b/Source/com/drew/metadata/mp4/boxes/UuidBox.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2002-2019 Drew Noakes and contributors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ * More information about this project is available at:
+ *
+ *    https://drewnoakes.com/code/exif/
+ *    https://github.com/drewnoakes/metadata-extractor
+ */
+package com.drew.metadata.mp4.boxes;
+
+import com.drew.lang.SequentialReader;
+import com.drew.metadata.mp4.Mp4BoxTypes;
+import com.drew.metadata.mp4.Mp4Directory;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.util.UUID;
+
+import static com.drew.metadata.mp4.media.Mp4UuidBoxDirectory.*;
+
+public class UuidBox extends Box
+{
+    private byte[] userData;
+
+    public UuidBox(SequentialReader reader, Box box) throws IOException
+    {
+        super(box);
+
+        if (type.equals(Mp4BoxTypes.BOX_USER_DEFINED)) {
+            usertype = getUuid(reader.getBytes(16));
+        }
+
+        userData = reader.getBytes(reader.available());
+    }
+
+    public void addMetadata(Mp4Directory directory)
+    {
+        directory.setString(TAG_UUID, usertype);
+        directory.setByteArray(TAG_USER_DATA, userData);
+    }
+
+    private String getUuid(byte[] bytes) {
+        ByteBuffer bb = ByteBuffer.wrap(bytes);
+        UUID uuid = new UUID(bb.getLong(), bb.getLong());
+
+        return uuid.toString();
+    }
+}
diff --git a/Source/com/drew/metadata/mp4/media/Mp4UuidBoxDescriptor.java b/Source/com/drew/metadata/mp4/media/Mp4UuidBoxDescriptor.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2002-2019 Drew Noakes and contributors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ * More information about this project is available at:
+ *
+ *    https://drewnoakes.com/code/exif/
+ *    https://github.com/drewnoakes/metadata-extractor
+ */
+package com.drew.metadata.mp4.media;
+
+import com.drew.metadata.TagDescriptor;
+
+public class Mp4UuidBoxDescriptor extends TagDescriptor<Mp4UuidBoxDirectory>
+{
+    public Mp4UuidBoxDescriptor(Mp4UuidBoxDirectory directory)
+    {
+        super(directory);
+    }
+}
diff --git a/Source/com/drew/metadata/mp4/media/Mp4UuidBoxDirectory.java b/Source/com/drew/metadata/mp4/media/Mp4UuidBoxDirectory.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2002-2019 Drew Noakes and contributors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ * More information about this project is available at:
+ *
+ *    https://drewnoakes.com/code/exif/
+ *    https://github.com/drewnoakes/metadata-extractor
+ */
+package com.drew.metadata.mp4.media;
+
+import com.drew.lang.annotations.NotNull;
+
+import java.util.HashMap;
+
+public class Mp4UuidBoxDirectory extends Mp4MediaDirectory
+{
+    public static final Integer TAG_UUID = 901;
+    public static final Integer TAG_USER_DATA = 902;
+
+    @NotNull
+    private static final HashMap<Integer, String> _tagNameMap = new HashMap<Integer, String>();
+
+    static
+    {
+        Mp4UuidBoxDirectory.addMp4MediaTags(_tagNameMap);
+        _tagNameMap.put(TAG_UUID, "uuid");
+        _tagNameMap.put(TAG_USER_DATA, "data");
+    }
+
+    public Mp4UuidBoxDirectory()
+    {
+        this.setDescriptor(new Mp4UuidBoxDescriptor(this));
+    }
+
+    @NotNull
+    @Override
+    public String getName()
+    {
+        return "UUID";
+    }
+
+    @NotNull
+    @Override
+    protected HashMap<Integer, String> getTagNameMap()
+    {
+        return _tagNameMap;
+    }
+}