diff --git a/README.md b/README.md index d208a31d2..cc35924ae 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,7 @@ The table below lists the status of currently-supported standards: | ST 1907 | Motion Imagery Metadata (MIMD): Payload | Implemented as of ST 1907.1. No interoperability testing. | | | ST 1908 | Motion Imagery Metadata (MIMD): Imager System | Implemented as of ST 1908.1. No interoperability testing. | | | ST 1909 | Metadata Overlay for Visualization | Mostly implemented as of ST 1909.1. No support for next zoom or the reticle. | [#97](https://github.com/WestRidgeSystems/jmisb/issues/97) | +| ST 2101 | Core Identifier for Class 1/Class 2 Motion Imagery | Implemented as of ST 2101. Support is FFmpeg codec-specific. | | jmisb aims to be cross-platform to run on any modern operating system. However, since efficient video coding tends to leverage natively-compiled binaries, currently diff --git a/api-ffmpeg/src/main/java/org/jmisb/api/video/CodecConfigurations.java b/api-ffmpeg/src/main/java/org/jmisb/api/video/CodecConfigurations.java index bfb680d45..b17a8cad4 100644 --- a/api-ffmpeg/src/main/java/org/jmisb/api/video/CodecConfigurations.java +++ b/api-ffmpeg/src/main/java/org/jmisb/api/video/CodecConfigurations.java @@ -16,6 +16,7 @@ private CodecConfigurations() { codecs.add( new CodecConfiguration("hevc_nvenc", "NVIDIA", CodecIdentifier.H265) .addCodecOption("tune", "zerolatency") + .addCodecOption("udu_sei", "1") .addCodecOption("preset", "ll")); codecs.add( new CodecConfiguration("libx265", "x265", CodecIdentifier.H265) @@ -24,6 +25,7 @@ private CodecConfigurations() { codecs.add( new CodecConfiguration("h264_nvenc", "NVIDIA", CodecIdentifier.H264) .addCodecOption("tune", "zerolatency") + .addCodecOption("udu_sei", "1") .addCodecOption("preset", "fast")); codecs.add( new CodecConfiguration("h264_qsv", "Intel QuickSync", CodecIdentifier.H264) @@ -38,6 +40,7 @@ private CodecConfigurations() { codecs.add( new CodecConfiguration("libx264", "x264", CodecIdentifier.H264) .addCodecOption("tune", "zerolatency") + .addCodecOption("udu_sei", "1") .addCodecOption("preset", "ultrafast")); } diff --git a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoDecodeThread.java b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoDecodeThread.java index 62dc305b9..8fd8fd7a7 100644 --- a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoDecodeThread.java +++ b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoDecodeThread.java @@ -39,6 +39,8 @@ import org.jmisb.api.klv.st0603.ST0603TimeStamp; import org.jmisb.api.klv.st0603.TimeStatus; import org.jmisb.api.klv.st0604.TimeStampUtilities; +import org.jmisb.api.klv.st1204.CoreIdentifier; +import org.jmisb.api.klv.st2101.ST2101Converter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -186,6 +188,7 @@ public void run() { ST0603TimeStamp motionImageryTimeStamp = null; TimeStatus timeStatus = null; + CoreIdentifier miisCoreId = null; AVFrameSideData sideData = av_frame_get_side_data(avFrame, AV_FRAME_DATA_SEI_UNREGISTERED); if (sideData != null) { @@ -196,7 +199,7 @@ public void run() { timeStatus = TimeStampUtilities.decodeTimeStatus(sideDataBytes); motionImageryTimeStamp = TimeStampUtilities.decodePrecisionTimeStamp(sideDataBytes); - // TODO: check the ST2101 UUID case. + miisCoreId = ST2101Converter.decodeCoreId(sideDataBytes); } } @@ -206,6 +209,7 @@ public void run() { VideoFrame videoFrame = new VideoFrame(image, pts); videoFrame.setTimeStamp(motionImageryTimeStamp); videoFrame.setTimeStatus(timeStatus); + videoFrame.setMiisCoreId(miisCoreId); queued = inputStream.queueVideoFrame(videoFrame, 20); } } else if (ret != -11 && ret != -35) // -11 = EAGAIN, -35 = EDEADLK diff --git a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoFrame.java b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoFrame.java index 13df66693..6017474f9 100644 --- a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoFrame.java +++ b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoFrame.java @@ -3,6 +3,7 @@ import java.awt.image.BufferedImage; import org.jmisb.api.klv.st0603.ST0603TimeStamp; import org.jmisb.api.klv.st0603.TimeStatus; +import org.jmisb.api.klv.st1204.CoreIdentifier; /** An uncompressed video frame. */ public class VideoFrame { @@ -10,6 +11,7 @@ public class VideoFrame { private final double pts; private ST0603TimeStamp timeStamp = null; private TimeStatus timeStatus = null; + private CoreIdentifier miisCoreId = null; /** * Create a video frame. @@ -85,4 +87,27 @@ public TimeStatus getTimeStatus() { public void setTimeStatus(TimeStatus timeStatus) { this.timeStatus = timeStatus; } + + /** + * Get the MIIS Core Identifier. + * + *

Not all frames will have a MIIS Core Identifier. ST 2101 requires it at least every 30 + * seconds, or when it changes. Also, this concept is fairly new, and there are a lot of older + * imagery sources. + * + * @return the core identifier for this frame, or null if there is no core identifier in the + * frame. + */ + public CoreIdentifier getMiisCoreId() { + return miisCoreId; + } + + /** + * Set the core identifier for this frame. + * + * @param miisCoreId the core identifier to set on the frame. + */ + public void setMiisCoreId(CoreIdentifier miisCoreId) { + this.miisCoreId = miisCoreId; + } } diff --git a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoInput.java b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoInput.java index adf7b6740..2ca3f9be9 100644 --- a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoInput.java +++ b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoInput.java @@ -298,6 +298,9 @@ private static VideoFrame deepCopy(VideoFrame frame) { if (frame.getTimeStatus() != null) { videoFrame.setTimeStatus(frame.getTimeStatus().deepCopy()); } + if (frame.getMiisCoreId() != null) { + videoFrame.setMiisCoreId(frame.getMiisCoreId()); + } return videoFrame; } diff --git a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoOutput.java b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoOutput.java index 895398e88..090169127 100644 --- a/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoOutput.java +++ b/api-ffmpeg/src/main/java/org/jmisb/api/video/VideoOutput.java @@ -22,11 +22,13 @@ import static org.bytedeco.ffmpeg.global.avformat.avio_close; import static org.bytedeco.ffmpeg.global.avutil.AVMEDIA_TYPE_DATA; import static org.bytedeco.ffmpeg.global.avutil.AVMEDIA_TYPE_VIDEO; +import static org.bytedeco.ffmpeg.global.avutil.AV_FRAME_DATA_SEI_UNREGISTERED; import static org.bytedeco.ffmpeg.global.avutil.AV_PIX_FMT_BGR24; import static org.bytedeco.ffmpeg.global.avutil.AV_PIX_FMT_YUV420P; import static org.bytedeco.ffmpeg.global.avutil.av_d2q; import static org.bytedeco.ffmpeg.global.avutil.av_frame_alloc; import static org.bytedeco.ffmpeg.global.avutil.av_frame_free; +import static org.bytedeco.ffmpeg.global.avutil.av_frame_new_side_data; import static org.bytedeco.ffmpeg.global.avutil.av_image_alloc; import static org.bytedeco.ffmpeg.global.avutil.av_image_fill_arrays; import static org.bytedeco.ffmpeg.global.avutil.av_inv_q; @@ -51,11 +53,13 @@ import org.bytedeco.ffmpeg.avformat.AVStream; import org.bytedeco.ffmpeg.avutil.AVDictionary; import org.bytedeco.ffmpeg.avutil.AVFrame; +import org.bytedeco.ffmpeg.avutil.AVFrameSideData; import org.bytedeco.ffmpeg.avutil.AVRational; import org.bytedeco.ffmpeg.swscale.SwsContext; import org.bytedeco.javacpp.BytePointer; import org.bytedeco.javacpp.DoublePointer; import org.bytedeco.javacpp.PointerPointer; +import org.jmisb.api.klv.st2101.ST2101Converter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -359,12 +363,13 @@ void cleanup() { } /** - * Copy a BufferedImage to avFrameDst, transforming to the pixel format required by the codec. + * Copy a VideoFrame to avFrameDst, transforming to the pixel format required by the codec. * - * @param image The input image + * @param frame The input video frame * @throws IOException If the frame could not be written */ - private void convert(BufferedImage image) throws IOException { + private void convert(VideoFrame frame) throws IOException { + BufferedImage image = frame.getImage(); // If needed, convert to TYPE_3BYTE_BGR format (TODO: is there a more efficient way?) BufferedImage inputImage = image; if (image.getType() != BufferedImage.TYPE_3BYTE_BGR) { @@ -450,6 +455,14 @@ private void convert(BufferedImage image) throws IOException { inputImage.getHeight(), new PointerPointer(avFrameDst), avFrameDst.linesize()); + + if (frame.getMiisCoreId() != null) { + byte[] sideData = ST2101Converter.coreIdToSideDataBytes(frame.getMiisCoreId()); + AVFrameSideData st2101_sei = + av_frame_new_side_data( + avFrameDst, AV_FRAME_DATA_SEI_UNREGISTERED, sideData.length); + st2101_sei.data().put(sideData, 0, sideData.length); + } } /** @@ -499,7 +512,7 @@ AVPacket convert(MetadataFrame frame) { * @throws IOException if an error occurs */ void encodeFrame(VideoFrame frame) throws IOException { - convert(frame.getImage()); + convert(frame); // Convert PTS in seconds to PTS in "time base" units long pts = Math.round(frame.getPts() / av_q2d(videoStream.time_base())); diff --git a/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFileInputOutputIT.java b/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFileInputOutputIT.java index 875f5aa3e..6abc9dbcb 100644 --- a/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFileInputOutputIT.java +++ b/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFileInputOutputIT.java @@ -7,8 +7,10 @@ import java.util.List; import java.util.SortedMap; import java.util.TreeMap; +import java.util.UUID; import javax.imageio.ImageIO; import org.jmisb.api.klv.IMisbMessage; +import org.jmisb.api.klv.st1204.CoreIdentifier; import org.jmisb.core.video.TimingUtils; import org.jmisb.st0102.Classification; import org.jmisb.st0102.CountryCodingMethod; @@ -291,7 +293,11 @@ private void createFile( UasDatalinkMessage message = new UasDatalinkMessage(values); - output.addVideoFrame(new VideoFrame(image, pts)); + VideoFrame frame = new VideoFrame(image, pts); + CoreIdentifier miisCoreId = new CoreIdentifier(); + miisCoreId.setMinorUUID(UUID.randomUUID()); + frame.setMiisCoreId(miisCoreId); + output.addVideoFrame(frame); output.addMetadataFrame(new MetadataFrame(message, pts)); pts += frameDuration; } diff --git a/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFrameTest.java b/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFrameTest.java index 25cdc15bf..82d3d1b57 100644 --- a/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFrameTest.java +++ b/api-ffmpeg/src/test/java/org/jmisb/api/video/VideoFrameTest.java @@ -1,8 +1,10 @@ package org.jmisb.api.video; import java.awt.image.BufferedImage; +import java.util.UUID; import org.jmisb.api.klv.st0603.ST0603TimeStamp; import org.jmisb.api.klv.st0603.TimeStatus; +import org.jmisb.api.klv.st1204.CoreIdentifier; import org.testng.Assert; import org.testng.annotations.Test; @@ -16,16 +18,23 @@ public void testBasic() { ST0603TimeStamp timestamp = new ST0603TimeStamp(1547483647000000L); frame1.setTimeStamp(timestamp); VideoFrame frame2 = new VideoFrame(image2, 0.033); + CoreIdentifier miisCoreIdentifier = new CoreIdentifier(); + miisCoreIdentifier.setMinorUUID(UUID.randomUUID()); frame2.setTimeStatus(new TimeStatus()); + frame2.setMiisCoreId(miisCoreIdentifier); Assert.assertEquals(frame1.getPts(), 0.0); Assert.assertEquals(frame2.getPts(), 0.033); Assert.assertEquals(frame1.getImage(), image1); Assert.assertEquals(frame1.getTimeStamp().getDisplayableValue(), "1547483647000000"); + Assert.assertNull(frame1.getMiisCoreId()); Assert.assertEquals(frame2.getImage(), image2); Assert.assertFalse(frame2.getTimeStatus().isDiscontinuity()); Assert.assertFalse(frame2.getTimeStatus().isReverse()); Assert.assertFalse(frame2.getTimeStatus().isLocked()); + Assert.assertNotNull(frame2.getMiisCoreId()); + Assert.assertEquals( + frame2.getMiisCoreId().getMinorUUID(), miisCoreIdentifier.getMinorUUID()); } } diff --git a/api/src/main/java/module-info.java b/api/src/main/java/module-info.java index d0ca1c579..49971eb63 100644 --- a/api/src/main/java/module-info.java +++ b/api/src/main/java/module-info.java @@ -17,4 +17,5 @@ exports org.jmisb.api.klv.st1201; exports org.jmisb.api.klv.st1204; exports org.jmisb.api.klv.st1303; + exports org.jmisb.api.klv.st2101; } diff --git a/api/src/main/java/org/jmisb/api/klv/st0603/TimeStatus.java b/api/src/main/java/org/jmisb/api/klv/st0603/TimeStatus.java index 9011b3325..4478f5fa2 100644 --- a/api/src/main/java/org/jmisb/api/klv/st0603/TimeStatus.java +++ b/api/src/main/java/org/jmisb/api/klv/st0603/TimeStatus.java @@ -164,4 +164,25 @@ public TimeStatus deepCopy() { copy.setDiscontinuity(this.isDiscontinuity(), this.isReverse()); return copy; } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + if (isLocked()) { + sb.append("Locked | "); + } else { + sb.append("Not locked | "); + } + if (isDiscontinuity()) { + sb.append("Discontinuity - "); + if (isReverse()) { + sb.append("Reverse"); + } else { + sb.append("Forward"); + } + } else { + sb.append("No discontinuity"); + } + return sb.toString(); + } } diff --git a/api/src/main/java/org/jmisb/api/klv/st1204/CoreIdentifier.java b/api/src/main/java/org/jmisb/api/klv/st1204/CoreIdentifier.java index b9424ab56..d15666325 100644 --- a/api/src/main/java/org/jmisb/api/klv/st1204/CoreIdentifier.java +++ b/api/src/main/java/org/jmisb/api/klv/st1204/CoreIdentifier.java @@ -391,6 +391,11 @@ public String getTextRepresentation() { return sb.toString(); } + @Override + public String toString() { + return getTextRepresentation(); + } + private void parseVersionAndUsage(String versionAndUsage) { int versionAndUsageValue = Integer.parseInt(versionAndUsage, 16); setVersion(versionAndUsageValue >> 8); diff --git a/api/src/main/java/org/jmisb/api/klv/st2101/ST2101Converter.java b/api/src/main/java/org/jmisb/api/klv/st2101/ST2101Converter.java new file mode 100644 index 000000000..89a6bb4ba --- /dev/null +++ b/api/src/main/java/org/jmisb/api/klv/st2101/ST2101Converter.java @@ -0,0 +1,93 @@ +package org.jmisb.api.klv.st2101; + +import java.util.Arrays; +import org.jmisb.api.klv.st1204.CoreIdentifier; + +/** + * Utility class for ST 2101 conversion of MIIS Core Identifier. + * + *

This class is not intended to be instantiated. Instead, use the required static methods + * directly. + */ +public class ST2101Converter { + + private static final byte[] ST2101_UUID_BYTES = + new byte[] { + (byte) 0xa5, + (byte) 0x50, + (byte) 0x52, + (byte) 0xaf, + (byte) 0x52, + (byte) 0x16, + (byte) 0x5f, + (byte) 0x45, + (byte) 0xa3, + (byte) 0x18, + (byte) 0x1c, + (byte) 0xfc, + (byte) 0x7a, + (byte) 0xbb, + (byte) 0xc2, + (byte) 0x67 + }; + + private static final int IDENTIFIER_OFFSET = 0; + private static final int IDENTIFIER_LENGTH = ST2101_UUID_BYTES.length; + private static final int MINIMUM_CORE_ID_LENGTH = 18; + private static final int MINIMUM_LENGTH = IDENTIFIER_LENGTH + MINIMUM_CORE_ID_LENGTH; + + private ST2101Converter() {} + + /** + * Convert a MIIS Core Identifier to ST 2101 SEI format. + * + * @param miisCoreId the Core Identifier to convert. + * @return encoded UUID and Core Identifier as a byte array. + */ + public static byte[] coreIdToSideDataBytes(CoreIdentifier miisCoreId) { + byte[] st2101value = miisCoreId.getRawBytesRepresentation(); + byte[] bytes = new byte[ST2101_UUID_BYTES.length + st2101value.length]; + System.arraycopy(ST2101_UUID_BYTES, 0, bytes, 0, ST2101_UUID_BYTES.length); + System.arraycopy(st2101value, 0, bytes, ST2101_UUID_BYTES.length, st2101value.length); + return bytes; + } + + /** + * Decode the MIIS Core Identifier from an encoded byte array. + * + *

To be valid, this will be the User Data Unregistered SEI entry, consisting of the UUID + * provided in ST 2101, followed by a MIIS Core Identifier. + * + * @param sideDataBytes the byte array of encoded data, beginning with the ST 2101 UUID. + * @return MIIS Core Identifier, or null if the byte array does not match the expected structure + * or content. + */ + public static CoreIdentifier decodeCoreId(byte[] sideDataBytes) { + if (isRequiredLength(sideDataBytes) && isCoreIdentifierSEI(sideDataBytes)) { + byte[] coreIdentifierBytes = + Arrays.copyOfRange(sideDataBytes, IDENTIFIER_LENGTH, sideDataBytes.length); + return CoreIdentifier.fromBytes(coreIdentifierBytes); + } else { + return null; + } + } + + private static boolean isRequiredLength(byte[] sideDataBytes) { + return sideDataBytes.length >= MINIMUM_LENGTH; + } + + private static boolean isCoreIdentifierSEI(byte[] sideDataBytes) { + return sideDataBytesStartsWithIdentifier(sideDataBytes, ST2101_UUID_BYTES); + } + + private static boolean sideDataBytesStartsWithIdentifier( + byte[] sideDataBytes, byte[] identifier) { + return Arrays.equals( + sideDataBytes, + IDENTIFIER_OFFSET, + IDENTIFIER_LENGTH, + identifier, + IDENTIFIER_OFFSET, + IDENTIFIER_LENGTH); + } +} diff --git a/api/src/main/java/org/jmisb/api/klv/st2101/package-info.java b/api/src/main/java/org/jmisb/api/klv/st2101/package-info.java new file mode 100644 index 000000000..0f1f51ea4 --- /dev/null +++ b/api/src/main/java/org/jmisb/api/klv/st2101/package-info.java @@ -0,0 +1,16 @@ +/** + * ST 2101 Core Identifier for Class 1/Class 2 Motion Imagery. + * + *

This standard (ST) provides guidance and requirements for how to insert a Motion Imagery + * Identification System (MIIS) Core Identifier (ID) into a Supplemental Enhancement Information + * (SEI) message of a MPEG compressed Class1/Class 2 Motion Imagery elementary stream. + * + *

MISB ST 1204 provides guidance in how to create a Binary Value Core ID as required here. + * + *

This standard recommends inserting the Core ID into a MPEG compressed Motion Imagery + * elementary stream when accompanied by associated metadata. This is critical in the event the + * Motion Imagery and its metadata become separated during post processing. + * + *

This standard does not apply to the MPEG-2 video format which does not support SEI messages. . + */ +package org.jmisb.api.klv.st2101; diff --git a/api/src/test/java/org/jmisb/api/klv/st0603/TimeStatusTest.java b/api/src/test/java/org/jmisb/api/klv/st0603/TimeStatusTest.java index a366b53a1..648ceed80 100644 --- a/api/src/test/java/org/jmisb/api/klv/st0603/TimeStatusTest.java +++ b/api/src/test/java/org/jmisb/api/klv/st0603/TimeStatusTest.java @@ -13,6 +13,7 @@ public void testDefaultConstructor() { assertFalse(timeStatus.isDiscontinuity()); assertFalse(timeStatus.isReverse()); assertEquals(timeStatus.getEncodedValue(), (byte) 0b10011111); + assertEquals(timeStatus.toString(), "Not locked | No discontinuity"); } @Test @@ -22,6 +23,7 @@ public void testFromEncodedValueConstructor() { assertFalse(timeStatus.isDiscontinuity()); assertFalse(timeStatus.isReverse()); assertEquals(timeStatus.getEncodedValue(), (byte) 0b10011111); + assertEquals(timeStatus.toString(), "Not locked | No discontinuity"); } @Test @@ -31,6 +33,7 @@ public void testFromEncodedValueConstructorLocked() { assertFalse(timeStatus.isDiscontinuity()); assertFalse(timeStatus.isReverse()); assertEquals(timeStatus.getEncodedValue(), (byte) 0b00011111); + assertEquals(timeStatus.toString(), "Locked | No discontinuity"); } @Test @@ -40,6 +43,7 @@ public void testFromEncodedValueConstructorForwardDiscontinuity() { assertTrue(timeStatus.isDiscontinuity()); assertFalse(timeStatus.isReverse()); assertEquals(timeStatus.getEncodedValue(), (byte) 0b11011111); + assertEquals(timeStatus.toString(), "Not locked | Discontinuity - Forward"); } @Test @@ -49,6 +53,7 @@ public void testFromEncodedValueConstructorReverseDiscontinuity() { assertTrue(timeStatus.isDiscontinuity()); assertTrue(timeStatus.isReverse()); assertEquals(timeStatus.getEncodedValue(), (byte) 0b11111111); + assertEquals(timeStatus.toString(), "Not locked | Discontinuity - Reverse"); } @Test diff --git a/api/src/test/java/org/jmisb/api/klv/st1204/CoreIdentifierTortureTest.java b/api/src/test/java/org/jmisb/api/klv/st1204/CoreIdentifierTortureTest.java index baa1b635a..ea187bc47 100644 --- a/api/src/test/java/org/jmisb/api/klv/st1204/CoreIdentifierTortureTest.java +++ b/api/src/test/java/org/jmisb/api/klv/st1204/CoreIdentifierTortureTest.java @@ -94,6 +94,7 @@ private void verifyCoreIdentifierE1BadCheck(CoreIdentifier coreIdentifier) { String expectedText = "0154:C7D1-6253-98A2-41C2-BA6E-90F8-FCC7-3914/E047-AB3E-81BE-41ED-9664-09B0-2F44-5FAB/5E71-B0DC-20FE-4920-8216-26D6-4F61-D863:C8"; assertEquals(coreIdentifier.getTextRepresentation(), expectedText); + assertEquals(coreIdentifier.toString(), expectedText); } @Test diff --git a/api/src/test/java/org/jmisb/api/klv/st2101/ST2101ConverterTest.java b/api/src/test/java/org/jmisb/api/klv/st2101/ST2101ConverterTest.java new file mode 100644 index 000000000..7e87f6f01 --- /dev/null +++ b/api/src/test/java/org/jmisb/api/klv/st2101/ST2101ConverterTest.java @@ -0,0 +1,181 @@ +package org.jmisb.api.klv.st2101; + +import static org.testng.Assert.*; + +import java.util.UUID; +import org.jmisb.api.klv.st1204.CoreIdentifier; +import org.jmisb.api.klv.st1204.IdType; +import org.testng.annotations.Test; + +/** + * Unit tests for ST2101Converter. + * + *

The values in this match the ST 2101 example. + */ +public class ST2101ConverterTest { + private static final UUID PLATFORM_UUID = + UUID.fromString("16B74341-0008-41A0-BE36-5B5AB96A3645"); + private static final UUID SENSOR_UUID = UUID.fromString("F592F023-7336-4AF8-AA91-62C00F2EB2DA"); + private static final byte[] ST2101_BYTES = + new byte[] { + (byte) 0xa5, + (byte) 0x50, + (byte) 0x52, + (byte) 0xaf, + (byte) 0x52, + (byte) 0x16, + (byte) 0x5f, + (byte) 0x45, + (byte) 0xa3, + (byte) 0x18, + (byte) 0x1c, + (byte) 0xfc, + (byte) 0x7a, + (byte) 0xbb, + (byte) 0xc2, + (byte) 0x67, + (byte) 0x01, + (byte) 0x70, + (byte) 0xF5, + (byte) 0x92, + (byte) 0xF0, + (byte) 0x23, + (byte) 0x73, + (byte) 0x36, + (byte) 0x4A, + (byte) 0xF8, + (byte) 0xAA, + (byte) 0x91, + (byte) 0x62, + (byte) 0xC0, + (byte) 0x0F, + (byte) 0x2E, + (byte) 0xB2, + (byte) 0xDA, + (byte) 0x16, + (byte) 0xB7, + (byte) 0x43, + (byte) 0x41, + (byte) 0x00, + (byte) 0x08, + (byte) 0x41, + (byte) 0xA0, + (byte) 0xBE, + (byte) 0x36, + (byte) 0x5B, + (byte) 0x5A, + (byte) 0xB9, + (byte) 0x6A, + (byte) 0x36, + (byte) 0x45 + }; + + @Test + public void toBytes() { + CoreIdentifier coreIdentifier = new CoreIdentifier(); + coreIdentifier.setVersion(1); + coreIdentifier.setSensorUUID(IdType.Physical, SENSOR_UUID); + coreIdentifier.setPlatformUUID(IdType.Virtual, PLATFORM_UUID); + byte[] res = ST2101Converter.coreIdToSideDataBytes(coreIdentifier); + assertEquals(res, ST2101_BYTES); + } + + @Test + public void toCoreId() { + CoreIdentifier miisCoreIdentifier = ST2101Converter.decodeCoreId(ST2101_BYTES); + assertNotNull(miisCoreIdentifier); + assertEquals(miisCoreIdentifier.getVersion(), 1); + assertEquals(miisCoreIdentifier.getSensorIdType(), IdType.Physical); + assertEquals(miisCoreIdentifier.getSensorUUID(), SENSOR_UUID); + assertEquals(miisCoreIdentifier.getPlatformIdType(), IdType.Virtual); + assertEquals(miisCoreIdentifier.getPlatformUUID(), PLATFORM_UUID); + assertNull(miisCoreIdentifier.getWindowUUID()); + assertNull(miisCoreIdentifier.getMinorUUID()); + } + + @Test + public void checkBadLength() { + CoreIdentifier miisCoreIdentifier = + ST2101Converter.decodeCoreId( + new byte[] { + (byte) 0xa5, + (byte) 0x50, + (byte) 0x52, + (byte) 0xaf, + (byte) 0x52, + (byte) 0x16, + (byte) 0x5f, + (byte) 0x45, + (byte) 0xa3, + (byte) 0x18, + (byte) 0x1c, + (byte) 0xfc, + (byte) 0x7a, + (byte) 0xbb, + (byte) 0xc2, + (byte) 0x67, + (byte) 0x01, + (byte) 0x70 + }); + assertNull(miisCoreIdentifier); + } + + @Test + public void checkBadUUID() { + CoreIdentifier miisCoreIdentifier = + ST2101Converter.decodeCoreId( + new byte[] { + (byte) 0xa5, + (byte) 0x50, + (byte) 0x52, + (byte) 0xaf, + (byte) 0x52, + (byte) 0x16, + (byte) 0x5f, + (byte) 0x45, + (byte) 0xa3, + (byte) 0x18, + (byte) 0x1c, + (byte) 0xfc, + (byte) 0x7a, + (byte) 0xbc, + (byte) 0xc2, + (byte) 0x67, + (byte) 0x01, + (byte) 0x70, + (byte) 0xF5, + (byte) 0x92, + (byte) 0xF0, + (byte) 0x23, + (byte) 0x73, + (byte) 0x36, + (byte) 0x4A, + (byte) 0xF8, + (byte) 0xAA, + (byte) 0x91, + (byte) 0x62, + (byte) 0xC0, + (byte) 0x0F, + (byte) 0x2E, + (byte) 0xB2, + (byte) 0xDA, + (byte) 0x16, + (byte) 0xB7, + (byte) 0x43, + (byte) 0x41, + (byte) 0x00, + (byte) 0x08, + (byte) 0x41, + (byte) 0xA0, + (byte) 0xBE, + (byte) 0x36, + (byte) 0x5B, + (byte) 0x5A, + (byte) 0xB9, + (byte) 0x6A, + (byte) 0x36, + (byte) 0x45 + }); + assertNull(miisCoreIdentifier); + } +} diff --git a/examples/generator/pom.xml b/examples/generator/pom.xml index a22e3e30b..832edb6ed 100644 --- a/examples/generator/pom.xml +++ b/examples/generator/pom.xml @@ -48,6 +48,11 @@ st1601 ${project.version} + + org.jmisb + st1602 + ${project.version} + diff --git a/examples/generator/src/main/java/org/jmisb/examples/generator/Generator.java b/examples/generator/src/main/java/org/jmisb/examples/generator/Generator.java index 12131d4ba..cfea919b6 100644 --- a/examples/generator/src/main/java/org/jmisb/examples/generator/Generator.java +++ b/examples/generator/src/main/java/org/jmisb/examples/generator/Generator.java @@ -320,7 +320,9 @@ public void generate() { } UasDatalinkMessage message = new UasDatalinkMessage(values); - output.addVideoFrame(new VideoFrame(image, pts * 1.0e-6)); + VideoFrame videoFrame = new VideoFrame(image, pts * 1.0e-6); + videoFrame.setMiisCoreId(coreIdentifier); + output.addVideoFrame(videoFrame); output.addMetadataFrame(new MetadataFrame(message, pts)); pts += frameDuration * 1.0e6; } diff --git a/examples/mimdgenerator/src/main/java/org/jmisb/examples/mimdgenerator/Generator.java b/examples/mimdgenerator/src/main/java/org/jmisb/examples/mimdgenerator/Generator.java index 6a97a4955..19bc81d48 100644 --- a/examples/mimdgenerator/src/main/java/org/jmisb/examples/mimdgenerator/Generator.java +++ b/examples/mimdgenerator/src/main/java/org/jmisb/examples/mimdgenerator/Generator.java @@ -153,7 +153,9 @@ public void generate() throws KlvParseException { try (FileOutputStream stream = new FileOutputStream(path)) { stream.write(message.getBytes()); } - output.addVideoFrame(new VideoFrame(image, pts)); + VideoFrame videoFrame = new VideoFrame(image, pts * 1.0e-6); + videoFrame.setMiisCoreId(coreIdentifier); + output.addVideoFrame(videoFrame); output.addMetadataFrame(new MetadataFrame(message, pts)); pts += frameDuration; } diff --git a/examples/timetransfer/src/main/java/org/jmisb/examples/timetransfer/Generator.java b/examples/timetransfer/src/main/java/org/jmisb/examples/timetransfer/Generator.java index aa2cef0fd..c570dfb15 100644 --- a/examples/timetransfer/src/main/java/org/jmisb/examples/timetransfer/Generator.java +++ b/examples/timetransfer/src/main/java/org/jmisb/examples/timetransfer/Generator.java @@ -91,7 +91,9 @@ public void generate() throws KlvParseException { long startTime = System.currentTimeMillis(); double pts = 1000.0 * System.currentTimeMillis(); // Close enough for this. for (long i = 0; i < numFrames; ++i) { - output.addVideoFrame(new VideoFrame(image, pts * 1.0e-6)); + VideoFrame videoFrame = new VideoFrame(image, pts * 1.0e-6); + videoFrame.setMiisCoreId(coreIdentifier); + output.addVideoFrame(videoFrame); if (i % (intervalBetweenTimeTransferPacksInSeconds * frameRate) == 0) { Request trackingRequest = new Request(); trackingRequest.setCommand(Command.Tracking); diff --git a/viewer/src/main/java/org/jmisb/viewer/MetadataTreePanel.java b/viewer/src/main/java/org/jmisb/viewer/MetadataTreePanel.java index eb7f6e6bf..4ec455ebd 100644 --- a/viewer/src/main/java/org/jmisb/viewer/MetadataTreePanel.java +++ b/viewer/src/main/java/org/jmisb/viewer/MetadataTreePanel.java @@ -14,13 +14,19 @@ import org.jmisb.api.klv.IKlvKey; import org.jmisb.api.klv.IKlvValue; import org.jmisb.api.klv.INestedKlvValue; +import org.jmisb.api.klv.st0603.ST0603TimeStamp; +import org.jmisb.api.klv.st0603.TimeStatus; +import org.jmisb.api.klv.st1204.CoreIdentifier; import org.jmisb.api.video.IMetadataListener; +import org.jmisb.api.video.IVideoListener; import org.jmisb.api.video.MetadataFrame; +import org.jmisb.api.video.VideoFrame; -public class MetadataTreePanel extends JPanel implements IMetadataListener { +public class MetadataTreePanel extends JPanel implements IMetadataListener, IVideoListener { private JTree tree; private static final String ROOT_NODE_NAME = "Metadata"; + private static final String VIDEO_METADATA_LABEL = "Video Frame Metadata"; public MetadataTreePanel() { super(new BorderLayout()); @@ -151,4 +157,97 @@ void clear() { DefaultTreeModel model = (DefaultTreeModel) tree.getModel(); model.setRoot(new DefaultMutableTreeNode(ROOT_NODE_NAME)); } + + @Override + public void onVideoReceived(VideoFrame frame) { + if ((frame.getMiisCoreId() != null) + || (frame.getTimeStamp() != null) + || (frame.getTimeStatus() != null)) { + final DefaultTreeModel model = (DefaultTreeModel) tree.getModel(); + final DefaultMutableTreeNode rootNode = + (DefaultMutableTreeNode) tree.getModel().getRoot(); + // if a node already exists for the message type, update it and return + Enumeration childEnumeration = rootNode.children(); + while (childEnumeration.hasMoreElements()) { + DefaultMutableTreeNode child = + (DefaultMutableTreeNode) childEnumeration.nextElement(); + if (child.toString().equals(VIDEO_METADATA_LABEL)) { + addFrameMetadata(model, child, frame); + return; + } + } + DefaultMutableTreeNode parent = new DefaultMutableTreeNode(VIDEO_METADATA_LABEL); + addFrameMetadata(model, parent, frame); + final int index = rootNode.getChildCount(); + model.insertNodeInto(parent, rootNode, index); + tree.invalidate(); + tree.scrollPathToVisible(new TreePath(parent.getPath())); + tree.expandRow(index); + } + } + + private void addFrameMetadata( + DefaultTreeModel model, DefaultMutableTreeNode parent, VideoFrame frame) { + if (frame.getTimeStamp() != null) { + addTimeStampFrameMetadata(model, parent, frame.getTimeStamp()); + } + if (frame.getTimeStatus() != null) { + addTimeStatusFrameMetadata(model, parent, frame.getTimeStatus()); + } + if (frame.getMiisCoreId() != null) { + addMiisFrameMetadata(model, parent, frame.getMiisCoreId()); + } + } + + private void addTimeStampFrameMetadata( + DefaultTreeModel model, DefaultMutableTreeNode parent, ST0603TimeStamp timestamp) { + MetadataEntry metadataEntry = + new MetadataEntry("Time Stamp", "Time Stamp", timestamp.getDisplayableValue()); + addFrameMetadataEntry(metadataEntry, model, parent); + } + + private void addTimeStatusFrameMetadata( + DefaultTreeModel model, DefaultMutableTreeNode parent, TimeStatus status) { + MetadataEntry metadataEntry = + new MetadataEntry("Time Status", "Time Status", status.toString()); + addFrameMetadataEntry(metadataEntry, model, parent); + } + + private void addMiisFrameMetadata( + DefaultTreeModel model, DefaultMutableTreeNode parent, CoreIdentifier miisCoreId) { + MetadataEntry metadataEntry = + new MetadataEntry( + "MIIS Core Identifier", + "MIIS Core Identifier", + miisCoreId.getTextRepresentation()); + addFrameMetadataEntry(metadataEntry, model, parent); + } + + private void addFrameMetadataEntry( + MetadataEntry metadataEntry, DefaultTreeModel model, DefaultMutableTreeNode parent) { + Enumeration childEnumeration = parent.children(); + boolean didFind = false; + while (childEnumeration.hasMoreElements()) { + DefaultMutableTreeNode child = (DefaultMutableTreeNode) childEnumeration.nextElement(); + MetadataEntry entry = (MetadataEntry) child.getUserObject(); + if (entry.getTag().equals(metadataEntry.getTag())) { + didFind = true; + if (!entry.getValue().equals(metadataEntry.getValue())) { + entry.setValue(metadataEntry.getValue()); + child.setUserObject(entry); + SwingUtilities.invokeLater(() -> model.reload(child)); + } + break; + } + } + if (!didFind) { + DefaultMutableTreeNode node = new DefaultMutableTreeNode(metadataEntry); + try { + SwingUtilities.invokeAndWait( + () -> model.insertNodeInto(node, parent, parent.getChildCount())); + } catch (InterruptedException | InvocationTargetException ex) { + // Ignore at this stage + } + } + } } diff --git a/viewer/src/main/java/org/jmisb/viewer/MisbViewer.java b/viewer/src/main/java/org/jmisb/viewer/MisbViewer.java index 65a42914b..ef9fa8f1b 100644 --- a/viewer/src/main/java/org/jmisb/viewer/MisbViewer.java +++ b/viewer/src/main/java/org/jmisb/viewer/MisbViewer.java @@ -223,6 +223,7 @@ private void openFile(String filename) { fileInput.addFrameListener(videoPanel); fileInput.addMetadataListener(videoPanel); + fileInput.addFrameListener(metadataPanel); fileInput.addMetadataListener(metadataPanel); fileInput.addMetadataListener(mapFrame); fileInput.addFrameListener(controlPanel);