This is an automated email from the ASF dual-hosted git repository.
tballison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tika.git
The following commit(s) were added to refs/heads/main by this push:
new d035bc1c4d TIKA-4802: Expose the MP4 video bitrate (video:bitrate)
(#2984)
d035bc1c4d is described below
commit d035bc1c4d5d658d890ebc09c4e7098e2c3f9beb
Author: Dominik Schmidt <[email protected]>
AuthorDate: Thu Aug 6 16:33:35 2026 +0200
TIKA-4802: Expose the MP4 video bitrate (video:bitrate) (#2984)
* TIKA-4802: Add video:bitrate from the MP4 BitRateBox
* TIKA-4802: Regenerate metadata registry for video:bitrate
---
.../main/java/org/apache/tika/metadata/Video.java | 7 ++
.../apache/tika/metadata/metadata-key-fields.json | 1 +
.../org/apache/tika/metadata/metadata-keys.json | 1 +
.../apache/tika/parser/mp4/TikaMp4BoxHandler.java | 6 ++
.../tika/parser/mp4/TikaMp4VideoHandler.java | 111 +++++++++++++++++++++
.../org/apache/tika/parser/mp4/MP4ParserTest.java | 4 +-
6 files changed, 129 insertions(+), 1 deletion(-)
diff --git a/tika-core/src/main/java/org/apache/tika/metadata/Video.java
b/tika-core/src/main/java/org/apache/tika/metadata/Video.java
index 6dc90345b5..89143ec5d0 100644
--- a/tika-core/src/main/java/org/apache/tika/metadata/Video.java
+++ b/tika-core/src/main/java/org/apache/tika/metadata/Video.java
@@ -30,4 +30,11 @@ public interface Video {
* measured rate.
*/
Property FRAME_RATE = Property.internalReal("video:frame-rate");
+
+ /**
+ * Average bitrate in bits per second, from the video track's BitRateBox
+ * ('btrt'). A per-stream value: in a file with several video tracks it
+ * reflects the last one.
+ */
+ Property BITRATE = Property.internalInteger("video:bitrate");
}
diff --git
a/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-key-fields.json
b/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-key-fields.json
index 70b36026b7..bba36567e8 100644
---
a/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-key-fields.json
+++
b/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-key-fields.json
@@ -493,6 +493,7 @@
{"class":"org.apache.tika.metadata.TikaPagedText","field":"PAGE_NUMBER","key":"tk:page:number"},
{"class":"org.apache.tika.metadata.TikaPagedText","field":"PAGE_NUMBERS","key":"tk:page:numbers"},
{"class":"org.apache.tika.metadata.TikaPagedText","field":"PAGE_ROTATION","key":"tk:page:rotation"},
+
{"class":"org.apache.tika.metadata.Video","field":"BITRATE","key":"video:bitrate"},
{"class":"org.apache.tika.metadata.Video","field":"FRAME_RATE","key":"video:frame-rate"},
{"class":"org.apache.tika.metadata.WARC","field":"WARC_PAYLOAD_CONTENT_TYPE","key":"warc:payload-content-type"},
{"class":"org.apache.tika.metadata.WARC","field":"WARC_RECORD_CONTENT_TYPE","key":"warc:record-content-type"},
diff --git
a/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-keys.json
b/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-keys.json
index db9cbb6ae3..f601ddfc8f 100644
---
a/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-keys.json
+++
b/tika-metadata-schema/src/main/resources/org/apache/tika/metadata/metadata-keys.json
@@ -507,6 +507,7 @@
{"key":"tk:version-count","namespace":"tk","valueType":"INTEGER","cardinality":"SIMPLE"},
{"key":"tk:version-number","namespace":"tk","valueType":"INTEGER","cardinality":"SIMPLE"},
{"key":"tk:warn:truncated-metadata","namespace":"tk","valueType":"BOOLEAN","cardinality":"SIMPLE"},
+
{"key":"video:bitrate","namespace":"video","valueType":"INTEGER","cardinality":"SIMPLE"},
{"key":"video:frame-rate","namespace":"video","valueType":"REAL","cardinality":"SIMPLE"},
{"key":"w:Comments","namespace":"w","valueType":"TEXT","cardinality":"BAG"},
{"key":"warc:WARC-Record-ID","namespace":"warc","valueType":"TEXT","cardinality":"SIMPLE"},
diff --git
a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4BoxHandler.java
b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4BoxHandler.java
index 0dfc66681f..f13b27e097 100644
---
a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4BoxHandler.java
+++
b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4BoxHandler.java
@@ -126,6 +126,12 @@ public class TikaMp4BoxHandler extends Mp4BoxHandler {
//sound track: our handler additionally reads DRM markers and the
//esds average bitrate from the sample description
return new TikaMp4SoundHandler(metadata, context, tikaMetadata);
+ } else if (box.equals("hdlr") && payload != null && payload.length >=
12
+ && payload[8] == 'v' && payload[9] == 'i'
+ && payload[10] == 'd' && payload[11] == 'e') {
+ //video track: our handler additionally reads the btrt average
+ //bitrate from the sample description
+ return new TikaMp4VideoHandler(metadata, context, tikaMetadata);
}
return super.processBox(box, payload, size, context);
diff --git
a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4VideoHandler.java
b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4VideoHandler.java
new file mode 100644
index 0000000000..142dfa18bc
--- /dev/null
+++
b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/main/java/org/apache/tika/parser/mp4/TikaMp4VideoHandler.java
@@ -0,0 +1,111 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+package org.apache.tika.parser.mp4;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import com.drew.imaging.mp4.Mp4Handler;
+import com.drew.metadata.Metadata;
+import com.drew.metadata.mp4.Mp4Context;
+import com.drew.metadata.mp4.media.Mp4VideoHandler;
+
+import org.apache.tika.io.EndianUtils;
+import org.apache.tika.metadata.Video;
+
+/**
+ * Extends the video track handling with what the base handler does not read
+ * from the sample description: the average bitrate from the 'btrt' BitRateBox.
+ * See TIKA-4802.
+ */
+class TikaMp4VideoHandler extends Mp4VideoHandler {
+
+ /**
+ * Fixed size of a VisualSampleEntry (ISO/IEC 14496-12) before its child
+ * boxes: the 8 byte box header, 8 bytes of SampleEntry (6 reserved, 2 data
+ * reference index) and 70 bytes of visual fields ending with the 32 byte
+ * compressor name, the depth and a pre-defined field.
+ */
+ private static final int VISUAL_ENTRY_SIZE = 86;
+
+ private final org.apache.tika.metadata.Metadata tikaMetadata;
+
+ TikaMp4VideoHandler(Metadata metadata, Mp4Context context,
+ org.apache.tika.metadata.Metadata tikaMetadata) {
+ super(metadata, context);
+ this.tikaMetadata = tikaMetadata;
+ }
+
+ @Override
+ public Mp4Handler<?> processBox(String type, byte[] payload, long boxSize,
+ Mp4Context context) throws IOException {
+ if ("stsd".equals(type) && payload != null) {
+ extractFromSampleDescriptions(payload);
+ }
+ return super.processBox(type, payload, boxSize, context);
+ }
+
+ /**
+ * Walks the sample description entries: 4 bytes version and flags, a
+ * 4 byte entry count, then one sample entry per count, each starting with
+ * its own size and format fourcc.
+ */
+ private void extractFromSampleDescriptions(byte[] b) {
+ if (b.length < 8) {
+ return;
+ }
+ long entryCount = EndianUtils.getUIntBE(b, 4);
+ int pos = 8;
+ for (long i = 0; i < entryCount && pos + 8 <= b.length; i++) {
+ long size = EndianUtils.getUIntBE(b, pos);
+ if (size < 16 || size > b.length - pos) {
+ break;
+ }
+ int end = pos + (int) size;
+ int bitRate = findBtrtAverageBitRate(b, pos + VISUAL_ENTRY_SIZE,
end);
+ if (bitRate > 0) {
+ tikaMetadata.set(Video.BITRATE, bitRate);
+ }
+ pos = end;
+ }
+ }
+
+ /**
+ * Scans the child boxes of a sample entry for a 'btrt' BitRateBox and
+ * returns its average bitrate, or 0 if there is none. The box body is the
+ * decoding buffer size, the maximum bitrate and the average bitrate.
+ */
+ private static int findBtrtAverageBitRate(byte[] b, int pos, int end) {
+ while (pos >= 0 && pos + 8 <= end) {
+ long size = EndianUtils.getUIntBE(b, pos);
+ if (size < 8 || size > end - pos) {
+ return 0;
+ }
+ if ("btrt".equals(fourCc(b, pos + 4)) && pos + 20 <= end) {
+ long averageBitRate = EndianUtils.getUIntBE(b, pos + 16);
+ return averageBitRate > 0 && averageBitRate <=
Integer.MAX_VALUE
+ ? (int) averageBitRate : 0;
+ }
+ pos += (int) size;
+ }
+ return 0;
+ }
+
+ private static String fourCc(byte[] b, int pos) {
+ return new String(b, pos, 4, StandardCharsets.ISO_8859_1);
+ }
+}
diff --git
a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/test/java/org/apache/tika/parser/mp4/MP4ParserTest.java
b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/test/java/org/apache/tika/parser/mp4/MP4ParserTest.java
index 0e3cbe1e3a..97197bcd4e 100644
---
a/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/test/java/org/apache/tika/parser/mp4/MP4ParserTest.java
+++
b/tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-audiovideo-module/src/test/java/org/apache/tika/parser/mp4/MP4ParserTest.java
@@ -185,10 +185,12 @@ public class MP4ParserTest extends TikaTest {
// TODO Test an old QuickTime Video File
@Test
public void testVideoFrameRate() throws Exception {
- // a 10 fps H.264 clip generated with ffmpeg (color source, 16x16, 1s)
+ // a 10 fps H.264 clip generated with ffmpeg (color source, 16x16, 1s);
+ // libx264 also writes the average bitrate into the btrt BitRateBox
XMLResult r = getXML("testMP4Video.mp4");
assertEquals("video/mp4", r.metadata.get(Metadata.CONTENT_TYPE));
assertEquals("10.0", r.metadata.get(Video.FRAME_RATE));
+ assertEquals("6536", r.metadata.get(Video.BITRATE));
}
@Test
