@pixwel/pixwel-sdk 1.1.0

package/test/Ingest.spec.js

@@ -0,0 +1,95 @@
+import Ingest from "../lib/Ingest";
+
+import mock from "./mocks/mediainfo.mock";
+import proresMock from "./mocks/prores.mock";
+import pngMock from "./mocks/mediainfo.png.mock";
+
+describe("Ingest", () => {
+	describe("mapMetaToTags", () => {
+		it("should throw exception if missing File object", () => {
+			let meta = {};
+			expect(() => {
+				let ingest = Ingest.mapMetaToTags(meta, "video");
+			}).toThrow("missing info.File");
+		});
+		it("should throw exception if missing File.track object", () => {
+			let meta = {
+				File: {}
+			};
+			expect(() => {
+				let ingest = Ingest.mapMetaToTags(meta, "video");
+			}).toThrow("missing info.File.track");
+		});
+		it("should return empty object of tags if no metadata supplied", () => {
+			let meta = {
+				File: {
+					track: {}
+				}
+			};
+			let ingest = Ingest.mapMetaToTags(meta, "video");
+			expect(ingest).toEqual({
+				Aspect: "",
+				Standard: "",
+				Resolution: "",
+				Codec: "",
+				"Frame Mode": "",
+				Text: "",
+				Usage: "",
+				Extra: [],
+				Framerate: "",
+				Duration: ""
+			});
+		});
+		it("should correctly map h264 metadata to tags", () => {
+			let meta = mock;
+			let ingest = Ingest.mapMetaToTags(meta, "video");
+			let expected = {
+				Aspect: "16:9",
+				Codec: "h264",
+				Duration: "",
+				Extra: [],
+				"Frame Mode": "progressive",
+				Framerate: "23.98",
+				Resolution: "640x360",
+				Standard: "ntsc",
+				Text: "",
+				Usage: "online"
+			};
+			expect(ingest).toEqual(expected);
+		});
+		it("should correctly map prores metadata to tags", () => {
+			let meta = proresMock;
+			let ingest = Ingest.mapMetaToTags(meta, "video");
+			let expected = {
+				Aspect: "16:9",
+				Codec: "prores",
+				Duration: "",
+				Extra: [],
+				"Frame Mode": "progressive",
+				Framerate: "23.98",
+				Resolution: "1920x1080",
+				Standard: "ntsc",
+				Text: "",
+				Usage: "broadcast"
+			};
+			expect(ingest).toEqual(expected);
+		});
+		it("should correctly map png metadata to tags", () => {
+			let meta = pngMock;
+			let ingest = Ingest.mapMetaToTags(meta, "image");
+			let expected = {
+				Aspect: "",
+				Codec: "",
+				Duration: "",
+				Extra: [],
+				"Frame Mode": "",
+				Framerate: "",
+				Resolution: "1240x859",
+				Standard: "",
+				Text: "",
+				Usage: ""
+			};
+			expect(ingest).toEqual(expected);
+		});
+	});
+});

package/test/Srt.spec.js

@@ -0,0 +1,111 @@
+import SRT from '../lib/Srt';
+
+let translation = {
+    "_id": "translation-wwz",
+    "status": "complete",
+    "workRequest": "wr1",
+    "asset": "assetA",
+    "language": "ENG",
+    "lines": [{
+        "number": 1,
+        "startTime": "00:00:00,840",
+        "stopTime": "00:00:04,880",
+        "range": [0.84, 4.88],
+        "text": "They've brought you\nthe most <i>unforgettable</i> families of all time.",
+        "alignment": "bottom",
+        "inOffset": 0.1,
+        "outOffset": -0.1
+    }, {
+        "number": 2,
+        "startTime": "00:00:05,580",
+        "stopTime": "00:00:07,400",
+        "range": [5.580, 7.4],
+        "text": "Da, da, da!",
+        "alignment": "top"
+    }, {
+        "number": 3,
+        "startTime": "00:00:07,400",
+        "stopTime": "00:00:11,750",
+        "range": [7.4, 11.75],
+        "text": "Now from DreamWorks Animation\ncomes the most unexpected family of all:",
+        "alignment": "bottom",
+        "inOffset": -0.1,
+        "outOffset": 0.1
+    }]
+};
+
+describe("SRT", function() {
+
+    var testDataSrt = "1\n" +
+        "00:00:00,940 --> 00:00:04,780\n" +
+        "They've brought you\n" +
+        "the most <i>unforgettable</i> families of all time.\n" +
+        "\n" +
+        "2\n" +
+        "00:00:05,580 --> 00:00:07,400\n" +
+        "Da, da, da!\n" +
+        "\n" +
+        "3\n" +
+        "00:00:07,300 --> 00:00:11,850\n" +
+        "Now from DreamWorks Animation\n" +
+        "comes the most unexpected family of all:\n\n";
+
+    describe("parse()", function() {
+        it("should parse a SRT file to a collection", function() {
+            var lines = SRT.parse(testDataSrt.split('\n'));
+            expect(lines[0].startTime).toEqual('00:00:00,940');
+            expect(lines[0].stopTime).toEqual('00:00:04,780');
+            expect(lines[0].text).toEqual("They've brought you\nthe most <i>unforgettable</i> families of all time.");
+
+            expect(lines[1].startTime).toEqual('00:00:05,580');
+            expect(lines[1].stopTime).toEqual('00:00:07,400');
+            expect(lines[1].text).toEqual('Da, da, da!');
+
+            expect(lines[2].startTime).toEqual('00:00:07,300');
+            expect(lines[2].stopTime).toEqual('00:00:11,850');
+            expect(lines[2].text).toEqual('Now from DreamWorks Animation\ncomes the most unexpected family of all:');
+        });
+    });
+
+    describe("export()", function() {
+        it("should export data back to a plain SRT format", function() {
+            var out = SRT.export(translation.lines);
+            expect(out).toEqual(testDataSrt);
+        });
+
+        it("takes in/out offset into account to build startTime/stopTime", function() {
+            var lines = SRT.parse(SRT.export(translation.lines).split('\n'));
+            expect(lines[0].startTime).toEqual('00:00:00,940');
+            expect(lines[0].stopTime).toEqual('00:00:04,780');
+        });
+    });
+
+    describe('with malformed SRT data', function() {
+        var testData = [
+            [
+                "1\n" +
+                "00:00:00,333 --> 00:00:00,963" +
+                "" +
+                "" +
+                "2" +
+                "00:00:01,005 --> 00:00:02,461" +
+                "The terminators are evolving." +
+                "" +
+                "3" +
+                "00:00:02,505 --> 00:00:03,001" +
+                "THIS" +
+                "YEAR\n\n"
+            ]
+        ];
+
+        // describe('parse()', function() {
+        //     it('throws an exception', function() {
+        //         testData.forEach(function(srtData) {
+        //             expect(function() {
+        //                 SRT.parse(srtData);
+        //             }).toThrow(new Error('Malformed SRT file'));
+        //         });
+        //     });
+        // });
+    });
+});

package/test/Sub.spec.js

@@ -0,0 +1,75 @@
+import SUB from '../lib/Sub';
+
+let translation = {
+    "_id": "translation-wwz",
+    "status": "complete",
+    "workRequest": "wr1",
+    "asset": "assetA",
+    "language": "ENG",
+    "lines": [{
+        "number": 1,
+        "startTime": "00:00:00,840",
+        "stopTime": "00:00:04,880",
+        "range": [0.84, 4.88],
+        "text": "They've brought you\nthe most <i>unforgettable</i> families of all time.",
+        "alignment": "bottom",
+        "inOffset": 0.1,
+        "outOffset": -0.1
+    }, {
+        "number": 2,
+        "startTime": "00:00:05,580",
+        "stopTime": "00:00:07,400",
+        "range": [5.580, 7.4],
+        "text": "Da, da, da!",
+        "alignment": "top"
+    }, {
+        "number": 3,
+        "startTime": "00:00:07,400",
+        "stopTime": "00:00:11,750",
+        "range": [7.4, 11.75],
+        "text": "Now from DreamWorks Animation\ncomes the most unexpected family of all:",
+        "alignment": "bottom",
+        "inOffset": -0.1,
+        "outOffset": 0.1
+    }]
+};
+
+describe("SUB", function() {
+
+    describe("parse()", function() {
+        it('should detect the SUB format and read it', function() {
+            var lines = SUB.parse([
+                "00:00:00,00:00:04",
+                "They've brought you",
+                "the most unforgettable families of all time.",
+                "",
+                "00:00:05,00:00:07",
+                "here!"
+            ]);
+            expect(lines[0].startTime).toEqual('00:00:00');
+            expect(lines[0].stopTime).toEqual('00:00:04');
+            expect(lines[0].text).toEqual("They've brought you\nthe most unforgettable families of all time.");
+
+            expect(lines[1].startTime).toEqual('00:00:05');
+            expect(lines[1].stopTime).toEqual('00:00:07');
+            expect(lines[1].text).toEqual('here!');
+        });
+    });
+
+    describe('with malformed SUB data', function() {
+        var testData = [
+            "00:00:02,505 --> 00:00:03,001\nTHIS YEAR\n",
+            "00:00:02,505 --> 00:00:03,001\nTHIS YEAR\n"
+        ];
+
+        // describe('parse()', function() {
+        //     it('throws an exception', function() {
+        //         angular.forEach(testData, function(subData) {
+        //             expect(function() {
+        //                 SUB.parse(subData);
+        //             }).toThrow(new Error('Malformed SUB file'));
+        //         });
+        //     });
+        // });
+    });
+});

package/test/TimeFormat.spec.js

@@ -0,0 +1,84 @@
+import TimeFormat from '../lib/TimeFormat';
+
+describe("TimeFormat", function() {
+
+    describe("isValidTime()", function() {
+        it("returns `true` for valid time", function() {
+            expect(TimeFormat.isValidTime('00:00:00,940')).toBe(true);
+            expect(TimeFormat.isValidTime('00:00:00.94')).toBe(true);
+            expect(TimeFormat.isValidTime('0:00:00.94')).toBe(true);
+        });
+        it("returns `false` for non valid time", function() {
+            expect(TimeFormat.isValidTime('00:00,940')).toBe(false);
+            expect(TimeFormat.isValidTime('94')).toBe(false);
+            expect(TimeFormat.isValidTime('hello')).toBe(false);
+        });
+    });
+
+    describe("timeToTimestamp()", function() {
+        it("builds a timestamp from a time string", function() {
+            expect(TimeFormat.timeToTimestamp('00:00:00,940')).toBe(0.94);
+            expect(TimeFormat.timeToTimestamp('00:00:00.94')).toBe(0.94);
+            expect(TimeFormat.timeToTimestamp('0:00:00.94')).toBe(0.94);
+        });
+
+        it("returns `0` for non valid time", function() {
+            expect(TimeFormat.timeToTimestamp('00:00,940')).toBe(0);
+            expect(TimeFormat.timeToTimestamp('94')).toBe(0);
+            expect(TimeFormat.timeToTimestamp('hello')).toBe(0);
+        });
+    });
+
+    describe("timeDiff()", function() {
+        it("returns a timestamp duration from two time string", function() {
+            expect(TimeFormat.timeDiff('00:00:00,940', '00:00:00,840')).toBe(-0.1);
+            expect(TimeFormat.timeDiff('00:00:00.94', '00:00:00.84')).toBe(-0.1);
+            expect(TimeFormat.timeDiff('0:00:00.94', '0:00:00.84')).toBe(-0.1);
+
+            expect(TimeFormat.timeDiff('00:00:00,840', '00:00:00,940')).toBe(0.1);
+            expect(TimeFormat.timeDiff('00:00:00.84', '00:00:00.94')).toBe(0.1);
+            expect(TimeFormat.timeDiff('0:00:00.84', '0:00:00.94')).toBe(0.1);
+        });
+
+        it("returns `0` when there's no time difference", function() {
+            expect(TimeFormat.timeDiff('00:00:00,940', '00:00:00,940')).toBe(0);
+            expect(TimeFormat.timeDiff('00:00:00,940', undefined)).toBe(0);
+            expect(TimeFormat.timeDiff(undefined, '00:00:00,940')).toBe(0);
+        });
+    });
+
+    describe("timestampDiff()", function() {
+        it("returns a timestamp duration from two time string", function() {
+            expect(TimeFormat.timestampDiff(0.94, 0.84)).toBe(-0.1);
+            expect(TimeFormat.timestampDiff(0.84, 0.94)).toBe(0.1);
+        });
+
+        it("returns `0` when there's no time difference", function() {
+            expect(TimeFormat.timestampDiff(0.94, 0.94)).toBe(0);
+            expect(TimeFormat.timestampDiff(0.94, undefined)).toBe(0);
+            expect(TimeFormat.timestampDiff(undefined, 0.94)).toBe(0);
+        });
+    });
+
+    describe("startTime()", function() {
+        it("builds the startTime from a line data", function() {
+            expect(TimeFormat.startTime({
+                startTime: '00:00:00,940',
+                stopTime: '00:00:01,480',
+                inOffset: 0.1,
+                outOffset: -0.1
+            })).toBe('00:00:01,040');
+        });
+    });
+
+    describe("stopTime()", function() {
+        it("builds the startTime from a line data", function() {
+            expect(TimeFormat.stopTime({
+                startTime: '00:00:00,940',
+                stopTime: '00:00:01,480',
+                inOffset: 0.1,
+                outOffset: -0.1
+            })).toBe('00:00:01,380');
+        });
+    });
+});

package/test/mocks/mediainfo.mock.js

@@ -0,0 +1,67 @@
+module.exports = {
+  "File": {
+    "track": [
+      {
+        "Format": "MPEG-4",
+        "Format_profile": "QuickTime",
+        "Codec_ID": "qt   0000.02 (qt  )",
+        "File_size": "1.11 MiB",
+        "Duration": "10s 55ms",
+        "Overall_bit_rate": "924 Kbps",
+        "Encoded_date": "UTC 1904-01-01 00:00:00",
+        "Tagged_date": "UTC 1904-01-01 00:00:00",
+        "Writing_application": "Lavf57.83.100",
+        "_type": "General"
+      },
+      {
+        "ID": "1",
+        "Format": "AVC",
+        "Format_Info": "Advanced Video Codec",
+        "Format_profile": "High@L3",
+        "Format_settings__CABAC": "Yes",
+        "Format_settings__ReFrames": "4 frames",
+        "Codec_ID": "avc1",
+        "Codec_ID_Info": "Advanced Video Coding",
+        "Duration": "10s 10ms",
+        "Bit_rate": "791 Kbps",
+        "Width": "640 pixels",
+        "Height": "360 pixels",
+        "Display_aspect_ratio": "16:9",
+        "Frame_rate_mode": "Constant",
+        "Frame_rate": "23.976 (24000/1001) fps",
+        "Color_space": "YUV",
+        "Chroma_subsampling": "4:2:0",
+        "Bit_depth": "8 bits",
+        "Scan_type": "Progressive",
+        "Bits__Pixel_Frame_": "0.143",
+        "Stream_size": "967 KiB (85%)",
+        "Language": "English",
+        "Encoded_date": "UTC 1904-01-01 00:00:00",
+        "Tagged_date": "UTC 1904-01-01 00:00:00",
+        "_type": "Video"
+      },
+      {
+        "ID": "2",
+        "Format": "AAC",
+        "Format_Info": "Advanced Audio Codec",
+        "Format_profile": "LC",
+        "Codec_ID": "40",
+        "Duration": "10s 55ms",
+        "Bit_rate_mode": "Constant",
+        "Bit_rate": "129 Kbps",
+        "Channel_s_": "2 channels",
+        "Channel_positions": "Front: L R",
+        "Sampling_rate": "44.1 KHz",
+        "Frame_rate": "43.066 fps (1024 spf)",
+        "Compression_mode": "Lossy",
+        "Stream_size": "158 KiB (14%)",
+        "Language": "English",
+        "Default": "Yes",
+        "Alternate_group": "1",
+        "Encoded_date": "UTC 1904-01-01 00:00:00",
+        "Tagged_date": "UTC 1904-01-01 00:00:00",
+        "_type": "Audio"
+      }
+    ]
+  }
+}

package/test/mocks/mediainfo.png.mock.js

@@ -0,0 +1,22 @@
+module.exports = {
+	File: {
+		track: [
+			{
+				Format: "PNG",
+				Format_Info: "Portable Network Graphic",
+				File_size: "518 KiB",
+				_type: "General"
+			},
+			{
+				Format: "PNG",
+				Format_Info: "Portable Network Graphic",
+				Width: "1 240 pixels",
+				Height: "859 pixels",
+				Bit_depth: "24 bits",
+				Compression_mode: "Lossless",
+				Stream_size: "518 KiB (100%)",
+				_type: "Image"
+			}
+		]
+	}
+};

package/test/mocks/mocks.js

@@ -0,0 +1,118 @@
+module.exports = {
+  tags: [
+    { name: 'online', type: 'Usage' },
+    { name: 'broadcast', type: 'Usage' },
+    { name: 'dcp', type: 'Usage' },
+    { name: 'cmyk', type: 'Usage' },
+    { name: 'rgb', type: 'Usage' },
+    { name: 'previewonly', type: 'Usage' },
+    { name: 'txtd', type: 'Text' },
+    { name: 'txtl', type: 'Text' },
+    { name: 'flattened', type: 'Text'},
+    { name: 'layered', type: 'Text'},
+    { name: 'txtl2', type: 'Text' },
+    { name: 'h264', type: 'Codec'},
+    { name: '1920x1080', type: 'Resolution'},
+    { name: '1080p', set: ['h264', '1920x1080', 'online']}
+  ],
+
+  types: [
+    { name: 'trailer.us', category: 'av', group: 'av' },
+    { name: 'trailer.intl', category: 'av', group: 'av'},
+    { name: 'tv-spot.us', category: 'av', group: 'av' },
+    { name: 'tv-spot.intl', category: 'av', group: 'av'},
+    { name: 'film-clip.intl', category: 'av', group: 'av'},
+    { name: 'strategy-deck', category: 'print', group: 'print'}
+  ],
+
+  assets: [
+    {
+      $links: {
+        self: 'http://api/assets/assetA',
+        project: 'http://api/projects/projectA',
+        studio: 'http://api/studios/studio1',
+        type: 'http://api/assetTypes/trailer.intl',
+        transcription: 'http://api/translations/translationA'
+      },
+      $flags: [],
+      $permissions: {
+        tags: {
+          online: ['txtd'],
+          broadcast: ['txtl'],
+          dcp: ['txtl', 'txtd']
+        }
+      },
+      _id: 'assetA',
+      type: 'trailer.intl',
+      name: 'Test Asset A',
+      slug: 'test-asset-a',
+      length: 4,
+      project: 'projectA',
+      studio: 'studio1'
+    },
+    {
+      $links: {
+        self: 'http://api/assets/assetB',
+        project: 'http://api/projects/projectA',
+        type: 'http://api/assetTypes/trailer.intl'
+      },
+      $flags: [
+        'new'
+      ],
+      $permissions: {
+        tags: {
+          online: ['txtd'],
+          broadcast: ['txtl', 'txtd'],
+          dcp: ['txtl', 'txtd']
+        }
+      },
+      _id: 'assetB',
+      name: 'Test Asset B',
+      type: 'trailer.us',
+      length: 8,
+      project: 'projectA'
+    },
+    {
+      $links: {
+        self: 'http://api/assets/assetC',
+        project: 'http://api/projects/projectC',
+        type: 'http://api/assetTypes/trailer.us'
+      },
+      $flags: [],
+      $permissions: {
+        tags: {
+          online: ['txtl'],
+          broadcast: ['txtl', 'txtd'],
+          dcp: ['txtl', 'txtd']
+        }
+      },
+      _id: 'assetC',
+      name: 'Test Asset C',
+      type: 'tv-spot.intl',
+      length: 15,
+      project: 'projectC'
+    },
+    {
+      $links: {
+        self: 'http://api/assets/assetD',
+        project: 'http://api/projects/projectC',
+        type: 'http://api/assetTypes/trailer.us'
+      },
+      $flags: [],
+      $permissions: {
+        tags: {
+          online: ['txtl'],
+          broadcast: ['txtl', 'txtd'],
+          dcp: ['txtl', 'txtd']
+        }
+      },
+      $feedback: {},
+      _id: 'assetD',
+      name: 'Test Asset D',
+      type: 'trailer.us',
+      creative: true,
+      length: 10,
+      project: 'projectC'
+    }
+  ]
+}

package/test/mocks/prores.mock.js

@@ -0,0 +1,71 @@
+module.exports = {
+    "File": {
+        "track": [{
+            "Format": "MPEG-4",
+            "Format_profile": "QuickTime",
+            "Codec_ID": "qt   2005.03 (qt  )",
+            "File_size": "64.3 MiB",
+            "Duration": "5s 5ms",
+            "Overall_bit_rate_mode": "Variable",
+            "Overall_bit_rate": "108 Mbps",
+            "Encoded_date": "UTC 2018-06-12 01:13:24",
+            "Tagged_date": "UTC 2018-06-12 01:13:27",
+            "Writing_library": "Apple QuickTime",
+            "Media_UUID": "97BAE66D-352F-412A-BEE6-67C976369B60",
+            "_type": "General"
+        }, {
+            "ID": "1",
+            "Format": "ProRes",
+            "Format_profile": "422",
+            "Codec_ID": "apcn",
+            "Duration": "5s 5ms",
+            "Bit_rate_mode": "Variable",
+            "Bit_rate": "106 Mbps",
+            "Width": "1 920 pixels",
+            "Height": "1 080 pixels",
+            "Display_aspect_ratio": "16:9",
+            "Frame_rate_mode": "Constant",
+            "Frame_rate": "23.976 (24000/1001) fps",
+            "Color_space": "YUV",
+            "Chroma_subsampling": "4:2:2",
+            "Scan_type": "Progressive",
+            "Bits__Pixel_Frame_": "2.123",
+            "Stream_size": "63.0 MiB (98%)",
+            "Language": "English",
+            "Encoded_date": "UTC 2018-06-12 01:13:24",
+            "Tagged_date": "UTC 2018-06-12 01:13:27",
+            "Color_primaries": "BT.709",
+            "Transfer_characteristics": "BT.709",
+            "Matrix_coefficients": "BT.709",
+            "_type": "Video"
+        }, {
+            "ID": "2",
+            "Format": "PCM",
+            "Format_settings__Endianness": "Little",
+            "Format_settings__Sign": "Signed",
+            "Codec_ID": "lpcm",
+            "Duration": "5s 5ms",
+            "Bit_rate_mode": "Constant",
+            "Bit_rate": "2 304 Kbps",
+            "Channel_s_": "2 channels",
+            "Channel_positions": "Front: L R",
+            "Sampling_rate": "48.0 KHz",
+            "Bit_depth": "24 bits",
+            "Stream_size": "1.37 MiB (2%)",
+            "Language": "English",
+            "Encoded_date": "UTC 2018-06-12 01:13:27",
+            "Tagged_date": "UTC 2018-06-12 01:13:27",
+            "_type": "Audio"
+        }, {
+            "ID": "3",
+            "Type": "Time code",
+            "Format": "QuickTime TC",
+            "Duration": "5s 5ms",
+            "Title": "untitled",
+            "Language": "English",
+            "Encoded_date": "UTC 2018-06-12 01:13:27",
+            "Tagged_date": "UTC 2018-06-12 01:13:27",
+            "_type": "Other"
+        }]
+    }
+}